Skip to content

Commit

Permalink
Merge pull request janus-idp#76 from mareklibra/onRelease.doc
Browse files Browse the repository at this point in the history
Provide documentation for the on-release GH action
  • Loading branch information
mareklibra authored Apr 3, 2023
2 parents c61e390 + bd4a083 commit 30a2be7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions plugins/parodos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,24 @@ proxy:
headers:
Authorization: 'Basic dGVzdDp0ZXN0'
```
## Release
The project is published to the NPM JS Registry on release: https://www.npmjs.com/package/@parodos/plugin-parodos.
To do a release:
- go to the project release page: https://github.com/parodos-dev/backstage-parodos/releases
- click **Create a new release**
- as a tag, use format **vX.Y.Z** (mind the **v** prefix!)
- as a title, use the same value as for the tag
- let the release notes to be generated, adjust
- click **Publish release**
The on-release GitHub action is triggered, leading to publishing the new version to the NPM registry.
To watch progress: https://github.com/parodos-dev/backstage-parodos/actions/workflows/on-release.yaml
If the action is failing on an expired token, it can be updated here: https://github.com/organizations/parodos-dev/settings/secrets/actions
As a side-effect of the action, a PR bumping the plugin version is created. Do not forget to merge it: https://github.com/parodos-dev/backstage-parodos/pulls

0 comments on commit 30a2be7

Please sign in to comment.