Skip to content

Commit

Permalink
chore: standardise release method (#68)
Browse files Browse the repository at this point in the history
- add standard-version
- add docs to show usage
- add hint to PR template to help contributors adhere to conventional commit spec for breaking changes
  • Loading branch information
frederickfogerty committed Jun 25, 2018
1 parent 594c457 commit 37b0779
Show file tree
Hide file tree
Showing 4 changed files with 1,532 additions and 28 deletions.
5 changes: 2 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@ Please don't hesitate to [ask questions][issues] for clarification, or to [make
delete everything above this line
-------------------------------------------

BREAKING CHANGE: description




Does this PR contain a breaking change? If yes, please update this description on the line above to include a short description of the breaking change. If no, please delete this line and the line above.

## Description

Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,14 @@ gulp test-full # run the test suite against all supported browsers (using Sauce
```
Please note: in order to run tests in-browser (with `gulp test-local`), Chrome and Firefox should be installed locally. If you want to run `gulp test-full`, `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` must be defined in your shell.
### Cutting a release
Ensure all commits and PR titles are correctly described using the [Conventional Commits Specification](https://conventionalcommits.org/)
```sh
npm install # update dependencies to latest
npm run release # build code, bump package version according to commit messages, and generate changelog
git push --follow-tags origin master # push to github and publish
npm publish # publish to npm
```
Loading

0 comments on commit 37b0779

Please sign in to comment.