Skip to content

Fix/Improve changelog generator workflow#1016

Open
gandie wants to merge 1 commit intomasterfrom
fix/changelog-pipeline
Open

Fix/Improve changelog generator workflow#1016
gandie wants to merge 1 commit intomasterfrom
fix/changelog-pipeline

Conversation

@gandie
Copy link
Contributor

@gandie gandie commented Mar 12, 2026

As discussed in #1011

@gandie gandie force-pushed the fix/changelog-pipeline branch from b2f98b6 to e826023 Compare March 12, 2026 12:22
@gandie gandie marked this pull request as ready for review March 13, 2026 10:19
Copilot AI review requested due to automatic review settings March 13, 2026 10:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the scheduled/manual changelog generation workflow to open an automated PR (with auto-merge enabled) instead of pushing directly to the default branch, addressing the recurring “invalid MDX breaks builds” issue by making failures fixable via PR edits.

Changes:

  • Refactors .github/workflows/changelog.yml to generate changelog + CLI docs, then open a PR via peter-evans/create-pull-request and enable auto-merge.
  • Adds a new generated changelog entry for the March 5–12 v2 API changes.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

File Description
changelog/2026-03-12-api-changes-v2.mdx Adds the generated weekly v2 API changelog entry (needs a small consistency fix noted in comments).
.github/workflows/changelog.yml Switches from direct commits/push to PR-based delivery with auto-merge enablement.

@gandie gandie force-pushed the fix/changelog-pipeline branch from 009dcb2 to df3a24d Compare March 13, 2026 10:33
@gandie
Copy link
Contributor Author

gandie commented Mar 13, 2026

@martin-helmich this should do the trick. Ignore Copilot review and test-runs done here, i removed test run artifacts from branch after tests. One caveat i ran into: Auto-merge is smart and immediately merges if no branch protection is found for target branch. That is why there is now a changelog-pipeline-test ruleset for testing.

Have a good time! 🖖

@gandie gandie requested a review from martin-helmich March 13, 2026 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants