Merge pull request #679 from Inhishonor/release-notes-workflow

Improve the release notes generation workflow
This commit is contained in:
octoshrimpy
2026-01-24 08:47:18 -05:00
committed by GitHub
3 changed files with 140 additions and 100 deletions
+35 -61
View File
@@ -24,7 +24,7 @@ concurrency:
cancel-in-progress: false cancel-in-progress: false
jobs: jobs:
release: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: write contents: write
@@ -32,6 +32,14 @@ jobs:
env: env:
RELEASE_REF: ${{ inputs.release_ref || 'master' }} RELEASE_REF: ${{ inputs.release_ref || 'master' }}
outputs:
version_name: ${{ steps.version.outputs.version_name }}
version_code: ${{ steps.version.outputs.version_code }}
tag_name: ${{ steps.version.outputs.tag_name }}
apk_release_path: ${{ steps.release_artifact.outputs.apk_release_path }}
apk_fdroid_path: ${{ steps.fdroid_artifact.outputs.apk_fdroid_path }}
checksums_path: ${{ steps.checksums.outputs.checksums_path }}
steps: steps:
- name: Checkout source - name: Checkout source
uses: actions/checkout@v4 uses: actions/checkout@v4
@@ -113,17 +121,18 @@ jobs:
run: | run: |
set -euo pipefail set -euo pipefail
python3 <<'PY' python3 <<'PY'
import os import os, pathlib, re
import pathlib
import re
gradle = pathlib.Path("presentation/build.gradle").read_text() gradle = pathlib.Path("presentation/build.gradle").read_text()
code_match = re.search(r"^\s*versionCode\s+(\d+)", gradle, re.MULTILINE) code_match = re.search(r"^\s*versionCode\s+(\d+)", gradle, re.MULTILINE)
name_match = re.search(r"^\s*versionName\s+['\"]([\d\.]+)['\"]", gradle, re.MULTILINE) name_match = re.search(r"^\s*versionName\s+['\"]([\d\.]+)['\"]", gradle, re.MULTILINE)
if not code_match or not name_match: if not code_match or not name_match:
raise SystemExit("Unable to read versionCode/versionName from presentation/build.gradle") raise SystemExit("Unable to read versionCode/versionName from presentation/build.gradle")
out = pathlib.Path(os.environ["GITHUB_OUTPUT"]) out = pathlib.Path(os.environ["GITHUB_OUTPUT"])
out.write_text(f"version_code={code_match.group(1)}\nversion_name={name_match.group(1)}\ntag_name=v{name_match.group(1)}\n") out.write_text(
f"version_code={code_match.group(1)}\n"
f"version_name={name_match.group(1)}\n"
f"tag_name=v{name_match.group(1)}\n"
)
PY PY
- name: Validate Gradle Wrapper - name: Validate Gradle Wrapper
@@ -165,58 +174,26 @@ jobs:
find . -name '*.apk' -type f -exec sha256sum {} \; > checksums.txt find . -name '*.apk' -type f -exec sha256sum {} \; > checksums.txt
echo "checksums_path=checksums.txt" >> "$GITHUB_OUTPUT" echo "checksums_path=checksums.txt" >> "$GITHUB_OUTPUT"
- name: Generate release notes generate_release_notes:
id: notes needs: build
uses: actions/github-script@v7 uses: ./.github/workflows/generate-release-notes.yml
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} release_ref: ${{ inputs.release_ref || 'master' }}
script: | version_name: ${{ needs.build.outputs.version_name }}
npm install semver
const semver = require('semver'); publish:
const tagName = 'v${{ steps.version.outputs.version_name }}'; needs: [build, generate_release_notes]
const {owner, repo} = context.repo; runs-on: ubuntu-latest
const {data: tags} = await github.rest.repos.listTags({
owner,
repo,
per_page: 100,
});
const currentVersion = semver.parse(tagName);
const previousTag = tags
.map(t => t.name)
.filter(name => semver.valid(name) && semver.lt(name, currentVersion))
.sort(semver.rcompare)[0];
const payload = {
owner,
repo,
tag_name: tagName,
target_commitish: '${{ env.RELEASE_REF }}',
};
if (previousTag) {
payload.previous_tag_name = previousTag;
}
const response = await github.request('POST /repos/{owner}/{repo}/releases/generate-notes', payload);
const notes = response.data.body || '';
core.setOutput('release_notes', notes);
steps:
- name: Sanitize release notes - name: Sanitize release notes
id: clean_notes id: clean_notes
shell: bash
env: env:
NOTES: ${{ steps.notes.outputs.release_notes }} NOTES: ${{ needs.generate_release_notes.outputs.release_notes }}
run: | run: |
set -euo pipefail set -euo pipefail
python3 <<'PY' python3 <<'PY'
import os import os, re, pathlib
import pathlib
import re
notes = os.environ.get("NOTES", "") notes = os.environ.get("NOTES", "")
clean = re.sub(r'(?<!\w)@([A-Za-z0-9][A-Za-z0-9-]*)', r'\1', notes) clean = re.sub(r'(?<!\w)@([A-Za-z0-9][A-Za-z0-9-]*)', r'\1', notes)
pathlib.Path("sanitized_notes.txt").write_text(clean) pathlib.Path("sanitized_notes.txt").write_text(clean)
@@ -224,22 +201,21 @@ jobs:
{ {
echo "clean_notes<<EOF" echo "clean_notes<<EOF"
cat sanitized_notes.txt cat sanitized_notes.txt
echo ""
echo "EOF" echo "EOF"
} >> "$GITHUB_OUTPUT" } >> "$GITHUB_OUTPUT"
- name: Publish GitHub release - name: Publish GitHub release
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
with: with:
tag_name: ${{ steps.version.outputs.tag_name }} tag_name: ${{ needs.build.outputs.tag_name }}
name: QUIK v${{ steps.version.outputs.version_name }} name: QUIK v${{ needs.build.outputs.version_name }}
draft: ${{ inputs.publish_release != true }} draft: ${{ inputs.publish_release != true }}
prerelease: ${{ inputs.prerelease }} prerelease: ${{ inputs.prerelease }}
body: ${{ steps.clean_notes.outputs.clean_notes }} body: ${{ steps.clean_notes.outputs.clean_notes }}
files: | files: |
${{ steps.release_artifact.outputs.apk_release_path }} ${{ needs.build.outputs.apk_release_path }}
${{ steps.fdroid_artifact.outputs.apk_fdroid_path }} ${{ needs.build.outputs.apk_fdroid_path }}
${{ steps.checksums.outputs.checksums_path }} ${{ needs.build.outputs.checksums_path }}
fail_on_unmatched_files: true fail_on_unmatched_files: true
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -251,16 +227,14 @@ jobs:
- name: Update F-Droid repo contents - name: Update F-Droid repo contents
env: env:
APK_PATH: ${{ steps.artifact.outputs.apk_path }} APK_PATH: ${{ needs.build.outputs.apk_release_path }}
VERSION_NAME: ${{ steps.version.outputs.version_name }} VERSION_NAME: ${{ needs.build.outputs.version_name }}
VERSION_CODE: ${{ steps.version.outputs.version_code }} VERSION_CODE: ${{ needs.build.outputs.version_code }}
run: | run: |
set -euo pipefail set -euo pipefail
mkdir -p repo mkdir -p repo
target_apk="repo/dev.octoshrimpy.quik_${VERSION_CODE}.apk" target_apk="repo/dev.octoshrimpy.quik_${VERSION_CODE}.apk"
cp "$APK_PATH" "$target_apk" cp "$APK_PATH" "$target_apk"
fdroid update --config config.yml --pretty fdroid update --config config.yml --pretty
- name: Publish F-Droid repo to GitHub Pages - name: Publish F-Droid repo to GitHub Pages
@@ -0,0 +1,80 @@
name: Generate Release Notes
on:
workflow_dispatch:
inputs: &note_inputs
release_ref:
description: Branch or tag to build from
required: false
default: master
type: string
version_name:
required: true
type: string
workflow_call:
inputs: *note_inputs
outputs:
release_notes:
description: Generated release notes
value: ${{ jobs.Generate.outputs.release_notes }}
jobs:
Generate:
outputs:
release_notes: ${{ steps.notes.outputs.release_notes }}
runs-on: ubuntu-latest
env:
RELEASE_REF: ${{ inputs.release_ref || 'master' }}
steps:
- name: Checkout source
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ env.RELEASE_REF }}
- name: Install Dependencies
run: npm install semver@7
- name: Generate Release Notes
id: notes
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const semver = require('semver');
const releaseName = 'v${{ inputs.version_name }}';
const { owner, repo } = context.repo;
const { data: releases } = await github.rest.repos.listReleases({
owner,
repo,
per_page: 100,
});
const currentVersion = semver.parse(releaseName);
const previousReleaseTag = releases
.filter(r => !r.draft && !r.prerelease)
.map(r => r.tag_name)
.filter(tag => semver.valid(tag) && semver.lt(tag, currentVersion))
.sort(semver.rcompare)[0];
const payload = {
owner,
repo,
tag_name: releaseName,
target_commitish: '${{ env.RELEASE_REF }}',
};
if (previousReleaseTag) {
payload.previous_tag_name = previousReleaseTag;
}
const response = await github.request(
'POST /repos/{owner}/{repo}/releases/generate-notes',
payload
);
const notes = response.data.body || '';
core.exportVariable('RELEASE_NOTES', notes);
core.setOutput('release_notes', notes);
+25 -39
View File
@@ -18,6 +18,10 @@ jobs:
env: env:
GRADLE_FILE: presentation/build.gradle GRADLE_FILE: presentation/build.gradle
outputs:
new_version_name: ${{ steps.bump.outputs.new_version_name }}
new_version_code: ${{ steps.bump.outputs.new_version_code }}
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
@@ -90,55 +94,37 @@ jobs:
env_file.write(f"NEW_VERSION_CODE={new_code}\n") env_file.write(f"NEW_VERSION_CODE={new_code}\n")
PY PY
- name: Generate release notes generate_release_notes:
id: notes needs: bump-version
uses: actions/github-script@v7 uses: ./.github/workflows/generate-release-notes.yml
with:
version_name: ${{ needs.bump-version.outputs.new_version_name }}
open_release_pr:
needs: [bump-version, generate_release_notes]
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} fetch-depth: 0
script: | persist-credentials: true
const newTag = `v${process.env.NEW_VERSION_NAME}`;
const {owner, repo} = context.repo;
const {data: tags} = await github.rest.repos.listTags({
owner,
repo,
per_page: 100,
});
const previousTagEntry = tags.find(tag => /^v\d/.test(tag.name));
const previousTag = previousTagEntry ? previousTagEntry.name : undefined;
const requestPayload = {
owner,
repo,
tag_name: newTag,
target_commitish: 'master',
};
if (previousTag) {
requestPayload.previous_tag_name = previousTag;
}
const response = await github.request('POST /repos/{owner}/{repo}/releases/generate-notes', requestPayload);
const notes = response.data.body || '';
core.exportVariable('RELEASE_NOTES', notes);
core.setOutput('release_notes', notes);
- name: Open release PR - name: Open release PR
uses: peter-evans/create-pull-request@v7 uses: peter-evans/create-pull-request@v7
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
branch: release/v${{ env.NEW_VERSION_NAME }} branch: release/v${{ needs.bump-version.outputs.new_version_name }}
delete-branch: false delete-branch: false
commit-message: "chore: release v${{ env.NEW_VERSION_NAME }} (${{ env.NEW_VERSION_CODE }})" commit-message: "chore: release v${{ needs.bump-version.outputs.new_version_name }} (${{ needs.bump-version.outputs.new_version_code }})"
title: Release v${{ env.NEW_VERSION_NAME }} (${{ env.NEW_VERSION_CODE }}) title: Release v${{ needs.bump-version.outputs.new_version_name }} (${{ needs.bump-version.outputs.new_version_code }})
body: | body: |
## Summary ## Summary
- bump `versionName` to `${{ env.NEW_VERSION_NAME }}` - bump `versionName` to `${{ needs.bump-version.outputs.new_version_name }}`
- bump `versionCode` to `${{ env.NEW_VERSION_CODE }}` - bump `versionCode` to `${{ needs.bump-version.outputs.new_version_code }}`
Triggered manually via the Manual Release Prep workflow with **${{ inputs.bump_component }}** bump. Triggered manually via the Manual Release Prep workflow with **${{ inputs.bump_component }}** bump.
## Auto-generated release notes ## Auto-generated release notes
${{ env.RELEASE_NOTES }} ${{ needs.generate_release_notes.outputs.release_notes }}