Setup "prepare release" and "release" actions

The `rake vox:tag` task is error prone as it push by default, without an
opportunity for a review, or updating a changelog.

Rely on the shared actions to prepare release, do release.  These expect
a version number but this project is special as the current date is the
version.  Current tags are barely readable in the format YYYYMMDDX where
X is a digit used to distinguish 2 releseas made the same day.

With this change, we move to the format YYYY-MM-DD-X which we hope is
more readable.  It is basically a form of [CalVer](https://calver.org/).

Because the UTC date is the same all over the world, and to avoid
mistakes, we do not allow the user to specify it when preparing / doing
releases.  The only drawback that we can see is that we can have
inconsistency if a release is prepared on one day, but the actual
release happen the following day.  It is not considered a critical thing
since we already have similar date inconsistencies in CHANGELOGs from
time to time for user facing projects, and this one is less problematic.

Author: smortex

.github/workflows/prepare_release.yml

@@ -0,0 +1,39 @@
+---
+name: 'Prepare Release'
+
+on:
+  workflow_dispatch: {}
+
+permissions: {}
+
+jobs:
+  get_next_release_version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.next_release.outputs.version }}
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Get next release version
+        id: next_release
+        run: |
+          echo version=$(bundle exec rake vox:version:next) >> "$GITHUB_OUTPUT"
+
+  prepare_release:
+    needs: get_next_release_version
+    uses: OpenVoxProject/shared-actions/.github/workflows/prepare_release.yml@main
+    with:
+      allowed_owner: 'OpenVoxProject'
+      version: ${{ needs.get_next_release_version.outputs.version }}
+    secrets:
+      github_pat: ${{ secrets.OPENVOXBOT_COMMIT_AND_PRS }}
+      ssh_private_key: ${{ secrets.OPENVOXBOT_SSH_PRIVATE_KEY }}

.github/workflows/release.yml

@@ -1,24 +1,39 @@
 ---
-name: Gem Release
+name: 'Release'
 
 on:
-  push:
-    tags:
-      - '*'
+  workflow_dispatch: {}
 
 permissions: {}
 
 jobs:
-  create-github-release:
-    # Prevent releases from forked repositories
-    if: github.repository_owner == 'OpenVoxProject'
-    name: Create GitHub release
-    runs-on: ubuntu-24.04
-    permissions:
-      contents: write # clone repo and create release
+  get_current_release_version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.current_release.outputs.version }}
     steps:
-      - name: Create Release
-        shell: bash
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: gh release create --repo ${{ github.repository }} ${{ github.ref_name }} --generate-notes
+      - name: Check out repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Get current release version
+        id: current_release
+        run: |
+          echo version=$(bundle exec rake vox:version:current) >> "$GITHUB_OUTPUT"
+
+  release:
+    uses: OpenVoxProject/shared-actions/.github/workflows/release.yml@main
+    needs: get_current_release_version
+    with:
+      allowed_owner: 'OpenVoxProject'
+      version: ${{ needs.get_current_release_version.outputs.version }}
+    secrets:
+      github_pat: ${{ secrets.OPENVOXBOT_COMMIT_AND_PRS }}
+      ssh_private_key: ${{ secrets.OPENVOXBOT_SSH_PRIVATE_KEY }}

Gemfile

@@ -22,4 +22,9 @@ group(:development, optional: true) do
   gem 'hashdiff', require: false
 end
 
+group(:release, optional: true) do
+  gem 'faraday-retry', '~> 2.1', require: false
+  gem 'github_changelog_generator', '~> 1.16.4', require: false
+end
+
 #gem 'rubocop', "~> 0.34.2"

tasks/tag.rake

@@ -0,0 +1,52 @@
+def current_version
+  @current_version ||= File.read(File.expand_path('../CHANGELOG.md', __dir__)).match(/^## \[([^\]]+)\]/) { |match| match[1] }
+rescue Errno::ENOENT
+  puts 'Cannot find current version from CHANGELOG.md.  Ignored'
+  @current_version = ''
+end
+
+def next_version
+  today_prefix = Time.now.utc.strftime('%Y-%m-%d')
+
+  if current_version.start_with?(today_prefix)
+    current_version.next
+  else
+    "#{today_prefix}-1"
+  end
+end
+
+desc 'Set the full version of the project'
+task 'vox:version:bump:full' do
+  puts 'This project use the current date as version number.  No bump needed.'
+end
+
+desc 'Get the current version of the project'
+task 'vox:version:current' do
+  puts current_version
+end
+
+desc 'Get the next version of the project'
+task 'vox:version:next' do
+  puts next_version
+end
+
+begin
+  require "github_changelog_generator/task"
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.header = <<~HEADER.chomp
+    # Changelog
+    All notable changes to this project will be documented in this file.
+    HEADER
+    config.user = "openvoxproject"
+    config.project = "puppet-runtime"
+    config.exclude_labels = %w[dependencies duplicate question invalid wontfix wont-fix modulesync skip-changelog]
+    config.since_tag = "202501080"
+    config.future_release = next_version
+  end
+rescue LoadError
+  task :changelog do
+    abort("Run `bundle install --with release` to install the `github_changelog_generator` gem.")
+  end
+end
+
+task 'release:prepare': :changelog