docs: added npm publishing docs

This commit is contained in:
Patrik Oldsberg
2020-03-25 12:11:17 +01:00
parent ebe2205ec6
commit 59c1cba6b9
2 changed files with 38 additions and 0 deletions
+1
View File
@@ -5,3 +5,4 @@ Check out [https://backstage.io]() or see the table of content below.
- [Architecture and terminology](architecture-terminology.md)
- [Getting started](getting-started/README.md)
- [References](reference/README.md)
- [Publishing](publishing.md)
+37
View File
@@ -0,0 +1,37 @@
# Publishing
## NPM
NPM packages are published through CI/CD in the
[.github/workflows/master.yml](../.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.
```sh
$ git checkout -b new-release
```
Then, from the root of the repo, run
```sh
$ 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:
```sh
$ 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.
[Back to Docs](README.md)