summaryrefslogtreecommitdiff
path: root/vendor/github.com/onsi/ginkgo/RELEASING.md
blob: db3d234c1c25afcf1ffbc615281e6f6aba05b620 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
A Ginkgo release is a tagged git sha and a GitHub release.  To cut a release:

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)
1. Update `VERSION` in `config/config.go`
1. Commit, push, and release:
  ```
  git commit -m "vM.m.p"
  git push
  gh release create "vM.m.p"
  git fetch --tags origin master
  ```