-
-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the CHANGELOG.md with all changes since last release
Co-authored-by: George Blue <gblue@pivotal.io>
- Loading branch information
Showing
2 changed files
with
19 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,12 @@ | ||
A Gomega release is a tagged sha and a GitHub release. To cut a release: | ||
|
||
1. Ensure CHANGELOG.md is uptodate. | ||
1. Ensure CHANGELOG.md is up to date. | ||
- Use `git log --pretty=format:'- %s [%h]' HEAD...vX.X.X` to list all the commits since the last release | ||
- Categorize the changes into | ||
- Breaking Changes (requires a major version) | ||
- New Features (minor version) | ||
- Fixes (fix version) | ||
- Maintenance (which in general should not be mentioned in `CHANGELOG.md` as they have no user impact) | ||
2. Update GOMEGA_VERSION in `gomega_dsl.go` | ||
3. Push a commit with the version number as the commit message (e.g. `v1.3.0`) | ||
4. Create a new [GitHub release](https://help.github.com/articles/creating-releases/) with the version number as the tag (e.g. `v1.3.0`). List the key changes in the release notes. | ||
4. Create a new [GitHub release](https://help.github.com/articles/creating-releases/) with the version number as the tag (e.g. `v1.3.0`). List the key changes in the release notes. |