From 7869db018fc9972e572129fab427c5f25e618b59 Mon Sep 17 00:00:00 2001 From: Van Thong Nguyen Date: Tue, 27 Oct 2020 14:26:56 +0100 Subject: [PATCH] update release checklist --- release-checklist.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/release-checklist.md b/release-checklist.md index 0d0ec456..320f3fb5 100644 --- a/release-checklist.md +++ b/release-checklist.md @@ -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.