diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 7b0cce673..bde4435dd 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -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 diff --git a/.gitignore b/.gitignore index 4a0ba10b1..9669bf146 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,5 @@ coverage # vscode generated .vscode + +/relnotes.md diff --git a/tasks/create_release_notes.rake b/tasks/create_release_notes.rake new file mode 100644 index 000000000..6ba815e7a --- /dev/null +++ b/tasks/create_release_notes.rake @@ -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