Skip to content

Commit

Permalink
docs: added npm publishing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rugvip committed Mar 25, 2020
1 parent ebe2205 commit 59c1cba
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 37 additions & 0 deletions docs/publishing.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 59c1cba

Please sign in to comment.