Skip to content

Commit

Permalink
docs: Add release process
Browse files Browse the repository at this point in the history
Closes #1167
  • Loading branch information
RichardLitt authored and gr2m committed Aug 22, 2018
1 parent 3a1325f commit 37e0d91
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Please note that this project is released with a [Contributor Code of Conduct](.
- [Generate README TOC](#generate-readme-toc)
- [Running tests](#running-tests)
* [Airplane mode](#airplane-mode)
- [Release Process](#release-process)
- [Becoming a maintainer](#becoming-a-maintainer)

<!-- tocstop -->
Expand Down Expand Up @@ -60,6 +61,12 @@ $ export AIRPLANE=true
$ npm test
```

## Release Process

All of our releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release). The commit messages pushed to the master branch trigger new releases. Semantic-release requires that commits follow certain convetions, [described above](#commit-message-conventions). semantic-release creates a GitHub release, adds release notes and publishes the new version to npm. This is why we do not store release notes in the [`CHANGELOG`](CHANGELOG.md) file - they're already on GitHub.

We use @nockbot as a separate account for releases, because npm tokens cannot be scoped to a single package. This improves our security model in case of a data breach involving npm tokens. @nockbot's credentials were set up by @gr2m; contact him if for any reason you need to change this in the future.

## Becoming a maintainer

So you want to do more than file a bug or submit a PR? Awesome!
Expand Down

0 comments on commit 37e0d91

Please sign in to comment.