Skip to content

Commit

Permalink
add instructions before pushing
Browse files Browse the repository at this point in the history
We've had some issues with versions not being added correctly because,
really, github_changelog_generator is a bit rough around the edges and
very particular about tags and stuff.

These instruction will hopefully help with that.
  • Loading branch information
misaka committed Oct 3, 2022
1 parent 8a056b5 commit 439222b
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,24 @@ task :prepare_release, %i[version] do |_, args|

sh 'gem', 'tag'

puts "Ready for release #{v_version}. If you're happy with it and the CHANGELOG.md, you can push it with:",
'',
' git push --tags origin'
puts <<~EOMESSAGE
Release #{v_version} is almost ready! Before you push:
- Check that the CHANGELOG.md has no empty sections with no changes listed,
duplicate version numbers (e.g. two v1.5.1 entries) or non-version entries
(e.g. "push"). There should also only typically be a section added for the
latest version being cut, and no changes to previous entries.
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

0 comments on commit 439222b

Please sign in to comment.