Replace the changelog action with a maintained one by shuo-zhou · Pull Request #22 · pykale/linear

shuo-zhou · 2026-09-20T16:26:54Z

Description

saadmk11/changelog-ci@v1.2.0 builds FROM python:3.12-slim-bullseye. Bullseye is end-of-life and Debian is draining its package pool, so apt-get install git fails with exit code 100 and the workflow cannot build at all. Switch to mikepenz/release-changelog-builder-action, which builds no Docker image and is actively maintained, keep the same label groups, and grant the workflow the permissions the changelog commit and the pull request comment need.

Re-runs are idempotent: a section that already exists for the version is replaced in place, and identical content produces no commit.

Status

Ready

Types of changes

Non-breaking change (fix or new feature that would not break existing functionality).
Breaking change (fix or new feature that would cause existing functionality to change).
New tests added to cover the changes.
In-line docstrings updated and documentation docs updated.

saadmk11/changelog-ci@v1.2.0 builds FROM python:3.12-slim-bullseye. Bullseye is end-of-life and Debian is draining its package pool, so apt-get install git fails with exit code 100 and the workflow cannot build at all. Switch to mikepenz/release-changelog-builder-action, which builds no Docker image and is actively maintained, keep the same label groups, and grant the workflow the permissions the changelog commit and the pull request comment need. Re-runs are idempotent: a section that already exists for the version is replaced in place, and identical content produces no commit.

codecov · 2026-09-20T16:29:05Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.16%. Comparing base (5b9ef29) to head (a78ea6c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #22   +/-   ##
=======================================
  Coverage   90.16%   90.16%           
=======================================
  Files          24       24           
  Lines        1922     1922           
=======================================
  Hits         1733     1733           
  Misses        189      189

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Copilot review overview

🟡 Changes recommended

Version-less release titles fail, and the workflow executes PR-controlled Python with write credentials.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 · 1

Open (2)

Avoid executing untrusted PR code with write-scoped credentials · New
Handle missing version matches without aborting the workflow · New

What changed in this PR

Replaces the obsolete changelog action with maintained release automation.

Changes:

Generates grouped release notes with a pinned action.
Adds idempotent changelog insertion and PR commenting.
Documents the updated release process.

File	Description
`CONTRIBUTING.md`	Documents automated changelog generation.
`.gitignore`	Updates generated/config file rules.
`.github/workflows/changelog.yml`	Implements the new workflow.
`.github/scripts/update_changelog.py`	Inserts or replaces release sections.
`.github/changelog-config.json`	Defines changelog grouping and formatting.
`.github/changelog-ci-config.json`	Removes the obsolete configuration.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

Copilot review overview

🔵 Needs a closer look

The write-scoped PR workflow that commits and pushes changes warrants final human validation.

Review effort: Balanced
Findings: None

Resolved since last review (2)

Avoid executing untrusted PR code with write-scoped credentials
Handle missing version matches without aborting the workflow

cmanjah

Could we add a few small tests for replace_section and drop_empty_groups? The update_changelog.py script has no tests.

Copilot

Copilot review overview

🔵 Needs a closer look

Category matching can duplicate entries, and releases containing only ignored changes currently fail.

Review effort: Balanced
Findings: None

Previously missed (2)

In code that hasn't changed since last review

Prevent PR duplication across multiple matching changelog categories

.github/changelog-config.json:26

The replacement action does not stop after the first matching category by default, so a PR carrying multiple configured labels is emitted once in every matching section. The previous builder explicitly removed a PR after its first match; add consume: true to each category to preserve that behavior and avoid duplicated changelog entries.

Handle releases containing only ignored changes without empty-body failure

.github/scripts/update_changelog.py:114

When the range contains PRs but every one has an ignore_labels label, the action renders only the empty Other Changes heading (its empty_template is used only when zero PRs were fetched). drop_empty_groups removes that heading, making body empty and failing every release containing only ignored changes. Handle the no-eligible-entry case as either a clean no-op or an explicit placeholder instead of treating it as a generation failure.

Copilot

Copilot review overview

🟢 Approval recommended

The maintained action migration is complete, pinned, permission-aware, and preserves the intended changelog behavior.

Review effort: Balanced
Findings: None

cmanjah · 2026-09-29T14:24:26Z

          if printf '%s' "$PR_TITLE" | grep -qi 'release'; then
+            # \b anchors both ends so "0.4.0rc1" isn't truncated into the
+            # unrelated version "0.4.0": only "a"/"b" pre-releases are
+            # supported, and anything else must fail loudly below rather
+            # than being silently misfiled under the wrong version.
            version=$(printf '%s' "$PR_TITLE" \
-              | grep -oEi 'v?[0-9]+\.[0-9]+\.[0-9]+([ab][0-9]+)?' \
+              | grep -oEi '\bv?[0-9]+\.[0-9]+\.[0-9]+([ab][0-9]+)?\b' \
              | head -n1 || true)
+            version=${version,,}
+            if [ -z "$version" ] && printf '%s' "$PR_TITLE" | grep -qE '[0-9]+\.[0-9]+\.[0-9]+'; then
+              echo "::error::Pull request title mentions a release and a version, but the version isn't a plain release or an a/b pre-release (e.g. 0.4.0 or 0.4.0b1): $PR_TITLE"
+              exit 1
+            fi


Thanks, this fixes the rc1 example and case normalization. However, \b allows a boundary before punctuation, so 0.2.0.post1, 0.2.0-rc1, and Bump... 0.2.0 to 0.3.0 ... still get truncated to 0.2.0 and bypass the error check. Could we validate the complete version token before accepting it?

Copilot

🔵 Needs a closer look

The updater currently reformats unrelated historical changelog sections.

0 open findings

Previously missed (1)

In code that hasn't changed since last review

Avoid normalizing existing changelog sections during updates

.github/scripts/update_changelog.py:100

tidy(merged) normalizes the entire changelog, so updating one release also strips Markdown hard-break spaces and collapses blank lines in every older, manually edited section. The prepend path on line 91 has the same side effect, which contradicts the documented replace/prepend-in-place behavior; preserve the existing prefix and suffix verbatim and tidy only the generated section.

🧠 Review effort: Balanced

Copilot

🟢 Approval recommended

The maintained action migration is complete, pinned, permission-aware, and safely handles repeat runs.

0 open findings

🧠 Review effort: Balanced

cmanjah

The changes look good for now. We may want to strengthen the PR title validation before the next RC, especially for incomplete versions or titles with multiple version candidates, and add regression tests for these cases.

shuo-zhou requested a balanced review from Copilot September 20, 2026 20:17

Copilot started reviewing on behalf of shuo-zhou September 20, 2026 20:17

View session

Copilot AI reviewed Sep 20, 2026

View reviewed changes

Comment thread .github/workflows/changelog.yml Outdated

Comment thread .github/workflows/changelog.yml Outdated

update changelog

222c0fb

shuo-zhou requested a balanced review from Copilot September 22, 2026 08:09

Copilot started reviewing on behalf of shuo-zhou September 22, 2026 08:10

View session

Copilot AI reviewed Sep 22, 2026

View reviewed changes

shuo-zhou requested a review from cmanjah September 22, 2026 08:15

cmanjah requested changes Sep 23, 2026

View reviewed changes

Comment thread .github/workflows/changelog.yml Outdated

Comment thread .github/workflows/changelog.yml

Comment thread .github/workflows/changelog.yml

Comment thread .github/workflows/changelog.yml Outdated

update changelog.yml

b68868b

shuo-zhou requested a balanced review from Copilot September 27, 2026 17:49

Copilot started reviewing on behalf of shuo-zhou September 27, 2026 17:50

View session

Copilot AI reviewed Sep 27, 2026

View reviewed changes

update changelog

b2928bf

shuo-zhou requested a balanced review from Copilot September 28, 2026 16:08

Copilot started reviewing on behalf of shuo-zhou September 28, 2026 16:09

View session

Copilot AI reviewed Sep 28, 2026

View reviewed changes

shuo-zhou requested a review from cmanjah September 28, 2026 16:12

cmanjah reviewed Sep 29, 2026

View reviewed changes

update changelog version regex

f189997

shuo-zhou requested a balanced review from Copilot October 7, 2026 22:57

Copilot started reviewing on behalf of shuo-zhou October 7, 2026 22:57

View session

Copilot AI reviewed Oct 7, 2026

View reviewed changes

update changlog

a78ea6c

shuo-zhou requested a balanced review from Copilot October 9, 2026 21:41

Copilot started reviewing on behalf of shuo-zhou October 9, 2026 21:42

View session

Copilot AI reviewed Oct 9, 2026

View reviewed changes

shuo-zhou requested a review from cmanjah October 10, 2026 16:28

cmanjah approved these changes Oct 15, 2026

View reviewed changes

shuo-zhou merged commit 4a6a781 into main Oct 15, 2026
9 checks passed

shuo-zhou deleted the ci/changelog-automation branch October 15, 2026 13:17

Conversation

shuo-zhou commented Sep 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Status

Types of changes

Uh oh!

codecov Bot commented Sep 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🔵 Needs a closer look

Uh oh!

cmanjah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🔵 Needs a closer look

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟢 Approval recommended

Uh oh!

cmanjah Sep 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

cmanjah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shuo-zhou commented Sep 20, 2026 •

edited

Loading

codecov Bot commented Sep 20, 2026 •

edited

Loading