backstage-plugins

Oriflame Backstage plugins.

Getting started

You may find our plugins in the ./plugins folder. You may start each plugin in isolated mode (navigate to the plugin folder and run yarn dev or yarn start:dev, see respective README). You may start also the simple backstage host with the plugins integrated via yarn dev (in root folder). You may run yarn test to run jest tests. For more information see CONTRIBUTING.md.

List of prerequisites are same as for the backstage. Please use Node.js version 20.x.

List of plugins

Name	Version	Description
score-card		Main idea behind it comes from a need to somehow visualize maturity of our services and to establish a process how to improve it (discuss with the teams what to focus on next).

Workflows

We use GitHub actions to check build, unit & end to end test and other validations during pull requests. We use them also to prepare releases and publish npm packages.

In overview:

• create branch, commit changes, run yarn changeset, commit and create PR -> CI workflow will run
• once merged to main (on push) Prepare release PR workflow -> Release new version(s) pull request is created automatically. It shall increase versions of packages and update changelogs in respective plugins and cleanup the .changeset folder.
• once this PR is merged to main Release and publish Workflow will create a new release on GitHub and also publishes changed plugins.

CI workflow

Source: .github/workflows/ci.yml

Shall be executed during pull requests to validate changes and also during push to main branch to keep validating the main trunk.

Prepare release PR workflow

Source: .github/workflows/release-prepare.yml

Shall be executed on push to main. It runs yarn release = increase versions of packages and update changelogs in respective plugins and cleanup the .changeset folder. It comit the changes in a new branch and prepare a new PR Release new version(s).

Release and publish Workflow

Source: .github/workflows/ci.yml

Shall be executed on push to main. In case the package versions are changed (which are by the previous PR) it creates a new release on GitHub and also publishes changed plugins to npm repository.

Renovate: Validate configuration

Source: .github/workflows/renovate-changesets.yml

Shall be executed during pull requests when renovate.json changes to validate the changes.

Renovate: Generate changeset

Source: .github/workflows/renovate-changesets.yml

Shall be executed during pull requests. In case the package versions are changed (and the PR was created by renovate bot) it pushes automatically generated .changesets entries.

Thank you note

When creating this repository (pipelines, e2e tests, monorepo setup...) we were inspired a lot by a following repository roadie-backstage-plugins.

@oriflame/backstage-plugin-score-card

0.9.1

Patch Changes

• c3cbaf0: Updated dependency react-router to 6.26.2. Updated dependency react-router-dom to 6.26.2.

0.9.0

Minor Changes

• 35c2578: Alternative way to dynamically set location of JSON file through the annotations field of catalog-info.yaml. To achieve this, configuration of scorecard/jsonDataUrl alongside github.com/project-slug annotations is required within the catalog-info.yaml file.
• 500e616: Added config options to customize reviewer and review date display behavior

0.8.0

Minor Changes

• 32cc2fb: Upgraded to Backstage core 1.22.1, support for React v18, Node 20, Cypress e2e test migrated to Playwright and more.

  BREAKING CHANGES:

  • EntityScoreExtended new required property id:string added to fullfill the Material UI Table row ID needs. Fix your clients by providing e.g. stringifyEntityRef(score.entityRef) as a value for the id.

0.7.1

Patch Changes

• 7b37b37: Added a configuration option to fetch all entities from the catalog to avoid "414 Request-URI Too Large" error (fix #184)

0.7.0

Minor Changes

• bd30933: wikiLinkTemplate is now optionnal

0.6.3

Patch Changes

• e8c6214: Bumped backstage core libs from 1.8.3 to 1.10.1

0.6.2

Patch Changes

• bbcae3e: Propagate title, subtitle and ScoreCardTableProps to ScoreBoardPage

0.6.1

Patch Changes

• d434c7d: Add property to filter scores by entity kind.

0.6.0

Minor Changes

• ec3991d: Allow any entity to be scored.

  BREAKING CHANGES:

  • SystemScore is renamed to EntityScore (and in a similar fashion all other System* components)
  • systemEntityName in EntityScore is replaced by entityRef
  • URL path to json files is changed from {jsonDataUrl}/{systemEntityName}.json to {jsonDataUrl}/{entity-namespace}/{entity-kind}/{entity-name}.json

Patch Changes

• 398f28d: bump version for backstage core components to 1.8.3

0.5.7

Patch Changes

• 111a8c1: Fix ScoreCardTable export and update its documentation

0.5.6

Patch Changes

• 3a2f7b5: Expose ScoreCardTable for usage outside ScoreBoardPage

0.5.5

Patch Changes

• 12cb1f1: Improve extensibility by adding scoreLabel, to override scorePercent and adding a title prop to ScoreCardTable component

0.5.4

Patch Changes

• ac868b1: bumped to 1.7.0 backstage core version

0.5.3

Patch Changes

• 71b3b50: revert of React18 support

0.5.2

Patch Changes

• 4da6557: Updated dependency react to ^16.13.1 || ^17.0.0 || ^18.0.0. Updated dependency react-dom to ^16.13.1 || ^17.0.0 || ^18.0.0.

0.5.1

Patch Changes

• d697d52: Bumped to backstage-core 1.6.0

0.5.0

Minor Changes

• a94816d: New config [wikiLinkTemplate]

0.4.2

Patch Changes

• c9c49d1: Fixed repository url (package metadata)

0.4.1

Patch Changes

• bumped dependencies