Skip to content

Commit

Permalink
Add release-it
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaffter committed Aug 4, 2021
1 parent eb1cfd5 commit 5956e06
Show file tree
Hide file tree
Showing 4 changed files with 1,894 additions and 1,500 deletions.
27 changes: 23 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,24 @@ plan to submit passes with the tests defined for this project:
## Release Procedure

Maintainers are required to follow the procedure below when creating a new
release.

TBA
release. Releases are created with the npm package [release-it].

1. [Identify whether the release is a major, minor or patch release.]
1. Obtain a [personal access token] (release-it only needs "repo" access; no
"admin" or other scopes).
2. Make sure the token is [available as an environment variable].
3. Preview the release information using one of the commands listed below. These
commands will not modify any local or remote files.
- `npm run release -- major --ci --dry-run`
- `npm run release -- minor --ci --dry-run`
- `npm run release -- patch --ci --dry-run`
4. Create the release using one of the commands listed below.
- `npm run release -- major --ci`
- `npm run release -- minor --ci`
- `npm run release -- patch --ci`
5. Check that the release has been successfully created on GitHub along with any
release artifacts that may have been created (GitHub Pages, Docker image
pushed to Docker registry, Python package published to PyPi, etc.).

## Getting Help

Expand All @@ -132,4 +147,8 @@ channel that best matches the topic of your request.
[docs site]: https://nlpsandbox.io
[Forking Workflow]: https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow
[package.json]: ../package.json
[NLP Sandbox Discord server]: https://nlpsandbox.io/discord
[NLP Sandbox Discord server]: https://nlpsandbox.io/discord
[release-it]: https://github.com/release-it/release-it
[Identify whether the release is a major, minor or patch release.]: https://semver.org/#summary
[personal access token]: https://github.com/settings/tokens/new?scopes=repo&description=release-it
[available as an environment variable]: https://github.com/release-it/release-it/blob/master/docs/environment-variables.md
13 changes: 13 additions & 0 deletions .release-it.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"git": {
"commitMessage": "Release ${version}",
"tagAnnotation": "${version}"
},
"npm": {
"publish": false
},
"github": {
"release": true,
"releaseName": "${version}"
}
}
Loading

0 comments on commit 5956e06

Please sign in to comment.