Skip to content

Commit

Permalink
update release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
nvthongswansea authored and bkircher committed Oct 27, 2020
1 parent b9a86d8 commit 7869db0
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions release-checklist.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
# Release Checklist

This repo uses [git flow](https://nvie.com/posts/a-successful-git-branching-model/) (I'm sorry). Not obligatory but you might want to install [gitflow tools](https://github.com/nvie/gitflow) to help with the commands (It's complicated). Install like `brew install git-flow` or `sudo dnf install gitflow` or whatever is suitable on your system. Make sure to tun `git flow init` once and answer the questions.
## Tag

On develop branch:
Add a tag. E.g:

- [ ] Create a release branch from develop: `git flow release start 3.1.0`
$ git tag v3.3.0

This will create and checkout a new release branch. On that release branch:
Push the tag. E.g:

- [ ] test everything is working as expected
- [ ] update changelog: add additions and fixes and set a release date
- [ ] `git flow release publish 3.1.0`
- [ ] `git flow release finish 3.1.0`
- [ ] create and push the tag `git push origin --tags v3.1.0` (Note: its origin here but it needs to be your remote's name here)
$ git push --tags

Make sure the new release branch is pushed to the right remote. Then go to GitHub and
## Do the Release and Verify

- [ ] create two (yes that's two) PRs on GitHub: one from release branch → develop
- [ ] another from release branch → master (make sure you do not accidentally remove the release branch when merging those PRs)

Back on develop branch:

- [ ] create new CHANGELOG.md stub for next release
Finally hop over to [GitHub](https://github.com/gridscale/gsclient-go/releases/) and finish up the draft release. Include the changelog entries in the release message.

0 comments on commit 7869db0

Please sign in to comment.