Files
backstage/docs/plugins/publishing.md
T
2021-01-12 13:52:58 +01:00

1.6 KiB

id, title, description
id title description
publishing Publishing Documentation on Publishing npm packages

npm

npm packages are published through CI/CD in the .github/workflows/master.yml workflow. Every commit that is merged to master will be checked for new versions of all public packages, and any new versions will automatically be published to npm.

Creating a new release

Version bumps are made through release PRs. To create a new release, checkout out a new branch that you will use for the release, e.g.

$ git checkout -b new-release

First bump the CHANGELOG.md in the root of the repo and commit. You bump it by adding a header for the new version just below the ## Next Release one.

Then, from the root of the repo, run

$ yarn release

This will bring up the lerna release CLI where you choose what type of version bump you want to make, (major/minor/patch/prerelease). The CLI will take you through choosing a version, previewing all changes, and then approving the release. Once the release is approved, a new commit is created that you can submit as a PR. Push the branch to GitHub:

$ git push origin -u new-release

And then create a PR. Once the PR is approved and merged into master, the master build will publish new versions of all bumped packages.

Include new changes in existing release PR

If you want to include some last minute changes to an existing release PR, follow these instructions:

$ git checkout master
$ git pull
$ git checkout new-release
$ git reset --hard master
$ yarn release
$ git push --force