diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 00000000..cb3a9a8b --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,17 @@ +name-template: "v$NEXT_PATCH_VERSION" +tag-template: "v$NEXT_PATCH_VERSION" +categories: + - title: "âš ï¸ Breaking Changes" + label: "âš ï¸ Breaking" + - title: "âœ¨ New Features" + label: "âœ¨ Feature" + - title: "ðŸ› Bug Fixes" + label: "ðŸ› Bug Fix" + - title: "ðŸ“š Documentation" + label: "ðŸ“š Docs" + - title: "ðŸ Housekeeping" + label: "ðŸ Housekeeping" +change-template: "- $TITLE (#$NUMBER) @$AUTHOR" +no-changes-template: "- No changes" +template: | + $CHANGES diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml new file mode 100644 index 00000000..e18c51bc --- /dev/null +++ b/.github/workflows/push.yml @@ -0,0 +1,12 @@ +on: push +name: Push +jobs: + draftRelease: + name: Draft Release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - name: Draft Release + uses: toolmantim/release-drafter@v5.2.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a5d6de6..7415d3ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,8 +31,15 @@ Pull requests are very welcome! Please try to follow these simple rules if appli * Make sure your patches are well tested. All specs run with `rake spec` must pass. * Update the [Yard](http://yardoc.org/) documentation. * Update the [README](https://github.com/guard/listen/blob/master/README.md). -* Update the [CHANGELOG](https://github.com/guard/listen/blob/master/CHANGELOG.md) for noteworthy changes. * Please **do not change** the version number. +The title of your PR will automatically be included in the release notes for the next version of the gem. A maintainer can add one of the following GitHub labels to the PR to automatically categorize it when the release notes are generated: + +- âš ï¸ Breaking +- âœ¨ Feature +- ðŸ› Bug Fix +- ðŸ“š Docs +- ðŸ Housekeeping + For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net). diff --git a/README.md b/README.md index 3522451d..7333e3e2 100644 --- a/README.md +++ b/README.md @@ -262,6 +262,24 @@ Pull requests are very welcome! Please try to follow these simple rules if appli For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net). +## Releasing + +### Prerequisites + +* You must have commit rights to the GitHub repository. +* You must have push rights for rubygems.org. + +### How to release + +1. Run `bundle install` to make sure that you have all the gems necessary for testing and releasing. +2. **Ensure all tests are passing by running `bundle exec rake`.** +3. Determine which would be the correct next version number according to [semver](http://semver.org/). +4. Update the version in `./lib/listen/version.rb`. +5. Update the version in the Install section of `./README.md` (`gem 'listen', '~> X.Y'`). +6. Commit the version in a single commit, the message should be "Preparing vX.Y.Z" +7. Run `bundle exec rake release:full`; this will tag, push to GitHub, and publish to rubygems.org. +8. Update and publish the release notes on the [GitHub releases page](https://github.com/guard/listen/releases) if necessary + ## Acknowledgments * [Michael Kessler (netzpirat)][] for having written the [initial specs](https://github.com/guard/listen/commit/1e457b13b1bb8a25d2240428ce5ed488bafbed1f).