Skip to content

Warn about direct CHANGELOG.md changes in PR checks - #4294

Open
mario-campos wants to merge 2 commits into
mainfrom
mario-campos-changelog-workflow-activation
Open

mario-campos wants to merge 2 commits into
mainfrom
mario-campos-changelog-workflow-activation

Conversation

@mario-campos

@mario-campos mario-campos commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

This PR adds a PR check for non-release/mergeback/update-bundle PRs. The check posts a sticky PR comment if CHANGELOG.md has been modified in the PR, warning the author to instead direct their change to a change-note.

This PR is split-off from #4217, which retains the prerequisite post-comment Action.

Note

CI is EXPECTED TO FAIL until #4217 is merged. The write-permission job intentionally checks out trusted main, not the PR head, and the prerequisite ./.github/actions/post-comment action is not on main yet.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Repository development/CI only

Which use cases does this change impact?

  • Workflow types: None of the production workflow types; only this repository's PR checks.

  • Products: No production analysis behavior changes.

Environments:

  • Testing/None - This change does not impact any CodeQL workflows in production.

How did/will you validate this change?

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Development/testing only - This change cannot cause any failures in production.

How will you know if something goes wrong after this change is released?

  • Other - Observe the PR Checks job logs and warning/resolution comments after the prerequisite merges and this PR is updated.

Are there any special considerations for merging or releasing this change?

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows. Existing repo-size commenting is preserved; the new local action requires Add CHANGELOG.md modification check and warning comment #4217 on main first.
  • Consider adding a changelog entry for this change. Not needed for repository-only CI activation.
  • Confirm the readme and docs have been updated if necessary. No production documentation changes are needed.

Split workflow activation from #4217 while keeping the comment action loaded from trusted main.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@mario-campos
mario-campos requested a review from a team as a code owner November 3, 2026 17:16
Copilot AI auto review requested due to automatic review settings November 3, 2026 17:16
@github-actions github-actions Bot added the size/S Should be easy to review label Nov 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The workspace-only install omits required root dependencies, leaving warning and resolution comment scripts at risk of module-loading failures in CI.

1 open issue
What changed in this PR

Activates warnings for direct CHANGELOG.md edits in repository PR checks, using the comment action supplied by prerequisite #4217. Production CodeQL workflows are unaffected.

Changes:

  • Detects changelog modifications and exposes the result as a job output.
  • Extends the commenting job with trusted main checkout and Node/dependency setup.
  • Adds sticky warning and update-only resolution comments, excluding release, backport, mergeback, and bundle-update branches.
File Description
.github/​workflows/​pr-checks.yml Wires changelog detection and warning/resolution comments into PR checks while preserving repo-size commenting.

Review effort: Balanced (auto)

Comment thread .github/workflows/pr-checks.yml Resolved
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@mario-campos
mario-campos requested a review from mbg November 3, 2026 17:46

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants