Skip to content

Commit

Permalink
Create GH release with notes on CI gem publishing
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bquorning committed Apr 4, 2024
1 parent 49e6562 commit 30504e0
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ jobs:
bundler-cache: true
ruby-version: ruby
- uses: rubygems/release-gem@v1
- name: Create a GitHub release
env:
GH_TOKEN: ${{ github.token }}
run: |
bundle exec rake create_release_notes
gh release create $(git tag --points-at @) --notes-file relnotes.md
- name: Replace version in Antora config
run: |
sed -i 's/version:.*$/version: ~/' docs/antora.yml
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ coverage

# vscode generated
.vscode

/relnotes.md
34 changes: 34 additions & 0 deletions tasks/create_release_notes.rake
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

0 comments on commit 30504e0

Please sign in to comment.