Skip to content

Commit

Permalink
Release process docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Prithvi Kanherkar committed Aug 13, 2020
1 parent b3ec7ee commit 2da5119
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,27 @@ not send out notifications when you add commits.
[on GitHub]: https://github.com/AzureAD/microsoft-authentication-library-for-js
[issue tracker]: https://github.com/AzureAD/microsoft-authentication-library-for-js/issues
[bypass the pre-commit]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---no-verify

### RELEASE

Releases are managed using [beachball](https://microsoft.github.io/beachball/) package. In short, `beachball` will enforce every PR to a release branch to include a changefile that will describe the feature as a changelog item. During publish, the package will compile changes for all relevant packages and perform a release to npm.

There are a few scripts added to the `package.json` to support this:

- `npm run beachball:change`

Generates a changefile based on the dev branch. This should be run on your PR before merging to dev. When this command is run, the type of change needs to be selected:

![Select Change Type](./docs/images/beachball-changetype.png)

`beachball` will then ask for the changelog message. Please enter a short description of the change as well as the PR number in parentheses at the end of the message. This does not need to be a verbose message.

![Enter changelog message](./docs/images/beachball-changemessage.png)

- `npm run beachball:check`

Checks that changefiles have been generated for relevant changed packages. Used by the CI tool on PRs, can also be used locally.

- `npm run beachball:publish`

Bumps versions and publishes all packages that have relevant changefiles. If the changefiles types are set to `None`, no version bump or publish is done. Run on push to the `master` branch.
Binary file added docs/images/beachball-changemessage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/beachball-changetype.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2da5119

Please sign in to comment.