-
-
Notifications
You must be signed in to change notification settings - Fork 278
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.
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
Automatically create release notes #1859
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,3 +23,5 @@ coverage | |
|
||
# vscode generated | ||
.vscode | ||
|
||
/relnotes.md |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# frozen_string_literal: true | ||
|
||
desc 'Create release notes for the most recent version.' | ||
task :create_release_notes do | ||
CreateReleaseNotes.call | ||
end | ||
|
||
# Create release notes from the most recent version in the CHANGELOG.md file. | ||
module CreateReleaseNotes | ||
module_function | ||
|
||
def call | ||
release_notes = new_version_changes.strip | ||
contributor_links = user_links(release_notes) | ||
|
||
File.open('relnotes.md', 'w') do |file| | ||
file << release_notes | ||
file << "\n\n" | ||
file << contributor_links | ||
file << "\n" | ||
end | ||
end | ||
|
||
def new_version_changes | ||
changelog = File.read('CHANGELOG.md') | ||
_, _, new_changes, _older_changes = changelog.split(/^## .*$/, 4) | ||
new_changes | ||
end | ||
|
||
def user_links(text) | ||
names = text.scan(/\[@(\S+)\]/).map(&:first).uniq.sort | ||
names.map { |name| "[@#{name}]: https://github.com/#{name}" }.join("\n") | ||
end | ||
end |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ask) Should we need to create a release version tag before this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. It’s created and pushed by line 20. And also, it should run before the
git push
below which would causegit tag --points-at @
to no longer return the current tag 😅There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can see a successful run in https://github.com/bquorning/bquorning-test-gem/actions/runs/8529988960/job/23366914966 which created:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank ypu for the explanation! I understand😀