Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release instructions relating to tagging #124

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Update release instructions relating to tagging #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,14 +499,14 @@ Please note that page caching is project specific and each project must carefull

1. Merge all changes to be included in the release into the main branch and run a `git pull` on your local main branch
2. Checkout a release branch: `git checkout -b v${NEW_VERSION}-release`, e.g. `git checkout -b v1.3.0-release`
3. Whilst on the release branch, bump the version and generate the CHANGELOG.md. This will commit and tag changes: `rake prepare_release[minor]`
3. Whilst on the release branch, bump the version and generate the CHANGELOG.md. `rake prepare_release[minor]`
> **NB**: Any updated dependencies will reflect in the `Gemfile.lock`. This only affects the local dev env, and only require that specs pass
> It could be nice to have tests to prove that connectivity to GCP still works after an update, but we aren't setup for that yet
4. Verify committed `CHANGELOG.md` changes and alter if necessary: `git show`
5. Push the branch: `git push origin v${NEW_VERSION}-release`, e.g. `git push origin v1.3.0-release`
6. Raise a version release PR on GitHub with the label `version-release`, and wait for approval
7. Once the PR has been approved, and prior to merging, push the tags: `git push --tags`
8. Merge the version release PR into main
7. Merge the version release PR into main
8. Tag the release by running `git tag v${NEW_VERSION}` followed by `git push --tags origin`

IMPORTANT: Pushing the tags will immediately make the release available even on a unmerged branch. Therefore, push the tags to Github only when the PR is approved and immediately prior to merging the PR.

Expand Down
11 changes: 0 additions & 11 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ task :prepare_release, %i[version] do |_, args|

sh 'git', 'commit', '-a', '-m', v_version

sh 'git', 'tag', v_version

puts <<~EOMESSAGE
Release #{v_version} is almost ready! Before you push:

Expand All @@ -36,14 +34,5 @@ task :prepare_release, %i[version] do |_, args|

git show -- CHANGELOG.md

- Ensure that if you rebase or amend HEAD in any way, the #{v_version} tag
points to the new HEAD; the references listed here should point to the
same SHA:

git show-ref tags/#{v_version} heads/#{v_version}-release

Once you're happy with the CHANGELOG.md and the tag, you can push it with:

git push --tags origin
EOMESSAGE
end
Loading