Automatically create release notes #1859
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
Adds a new rake task, `rake create_release_notes` which generates a relnotes.md file. When CI creates and publishes a new gem version, it will now also create a release on GitHub, with the content of relnotes.md being used as release notes.
bquorning
force-pushed
the
automatically-create-release-notes
branch
from
b53f4fb to
30504e0
Compare
ydah
reviewed
Apr 4, 2024
| GH_TOKEN: ${{ github.token }} | ||
| run: | | ||
| bundle exec rake create_release_notes | ||
| gh release create $(git tag --points-at @) --notes-file relnotes.md |
There was a problem hiding this comment.
ask) Should we need to create a release version tag before this?
There was a problem hiding this comment.
Yes. It’s created and pushed by line 20. And also, it should run before the git push below which would cause git tag --points-at @ to no longer return the current tag 😅
There was a problem hiding this comment.
You can see a successful run in https://github.com/bquorning/bquorning-test-gem/actions/runs/8529988960/job/23366914966 which created:
- gem: https://rubygems.org/gems/bquorning-test-gem/versions/0.7.2
- git tag: https://github.com/bquorning/bquorning-test-gem/tree/v0.7.2
- github release: https://github.com/bquorning/bquorning-test-gem/releases/tag/v0.7.2
- pushed a separate commit to main: bquorning/bquorning-test-gem@97240ff
There was a problem hiding this comment.
Thank ypu for the explanation! I understand😀
ydah
added a commit
to rubocop/rubocop-capybara
that referenced
this pull request
Apr 8, 2024
3 tasks
ydah
added a commit
to rubocop/rubocop-factory_bot
that referenced
this pull request
Apr 8, 2024
3 tasks
ydah
added a commit
to rubocop/rubocop-rspec_rails
that referenced
this pull request
Apr 8, 2024
3 tasks
ydah
added a commit
to rubocop/rubocop-capybara
that referenced
this pull request
Apr 10, 2024
ydah
added a commit
to rubocop/rubocop-factory_bot
that referenced
this pull request
Apr 10, 2024
ydah
added a commit
to rubocop/rubocop-rspec_rails
that referenced
this pull request
Apr 10, 2024
ydah
added a commit
to rubocop/rubocop-capybara
that referenced
this pull request
Apr 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new rake task,
rake create_release_noteswhich generates a relnotes.md file.When CI creates and publishes a new gem version, it will now also create a release on GitHub, with the content of relnotes.md being used as release notes.
Before submitting the PR make sure the following are checked:
master(if not - rebase it).CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).