Skip to content

[CHORE](ci) Skip changelog fragment check for bot-labeled PRs - #645

Merged
John McCall (lowlydba) merged 6 commits into
mainfrom
bot-label-changelog-skip
Aug 11, 2026
Merged

[CHORE](ci) Skip changelog fragment check for bot-labeled PRs#645
John McCall (lowlydba) merged 6 commits into
mainfrom
bot-label-changelog-skip

Conversation

@lowlydba

@lowlydba John McCall (lowlydba) commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Problem

Dependabot PRs fail require-changelog-fragment.yaml because dependency bumps don't carry a changelog.d/ fragment, and shouldn't need one. Every Dependabot PR needs a manual override to merge.

Fix

Skip check-fragment when the PR carries the bot label. Dependabot already applies bot on both the github-actions and uv update configs in .github/dependabot.yml, so this needs no dependabot.yml changes, just the job's if condition.

Also skip it when the PR doesn't touch packages/ at all: docs, root-level files, and CI config were never going to need a fragment, since check-fragment only ever inspects packages/<package>/ paths. A new detect-scope job uses tj-actions/changed-files (matching the convention already used in detect-affected-packages) as an allow-list on packages/**, so this covers .github-only, docs-only, and root-only PRs alike without an ignore entry per top-level directory.

A job that sometimes doesn't run can't be a required status check, so check-fragment alone can't stay required. Added changelog-fragment-status, a final gate that always runs and uses lowlydba/are-we-good to roll detect-scope and check-fragment's results into a pass on either a real success or an accepted skip.

Important

Branch protection needs to require changelog-fragment-status instead of check-fragment for this to take effect.

Fixes #644

Dependabot PRs fail this check because dependency bumps don't carry
a changelog.d/ fragment, and shouldn't need one. Dependabot already
applies the bot label on both the github-actions and uv update
configs in .github/dependabot.yml, so gating the job on that label
needs no dependabot.yml changes.

Fixes #644

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>
@lowlydba John McCall (lowlydba) added the automation 🦾 Change/enhance automation of a process label Aug 6, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>
check-fragment now skips for bot-labeled PRs, so branch protection can't
require it directly (a job that sometimes doesn't run can't be a required
check). Add changelog-fragment-status as a final gate using
lowlydba/are-we-good, which always runs and passes on either a real
success or an accepted skip. Require that job in branch protection
instead of check-fragment.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>
@lowlydba
John McCall (lowlydba) marked this pull request as ready for review August 6, 2026 16:25
@lowlydba
John McCall (lowlydba) requested a review from a team as a code owner August 6, 2026 16:25
Copilot AI lite review requested due to automatic review settings August 6, 2026 16:25

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.

Pull request overview

Updates the changelog-fragment enforcement workflow so automation PRs (e.g., Dependabot) can merge without needing a changelog.d/ fragment, while still providing a consistently-present status check suitable for branch protection rules.

Changes:

  • Skips the check-fragment job when the PR has the bot label.
  • Adds an always-running changelog-fragment-status gate job that aggregates the check-fragment outcome (including accepted skips) via lowlydba/are-we-good.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/require-changelog-fragment.yaml
Add detect-scope, using tj-actions/changed-files (already the repo's
convention in detect-affected-packages) to report whether anything
outside .github/ changed. check-fragment now skips when it hasn't,
same as the bot-label skip, since workflow and CI config aren't
packages. changelog-fragment-status rolls detect-scope in too, so a
detect-scope failure surfaces instead of reading as an accepted skip.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>
Switch detect-scope from an ignore-list (.github/**) to an allow-list
(packages/**): check-fragment only ever inspects packages/<package>/
paths, so anything that doesn't touch packages/ -- docs, root-level
files, CI config -- never needed a fragment. This covers docs-only and
root-only PRs the same way it already covered .github-only ones,
without another ignore entry per new top-level directory.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

🗺️ Schema reference docs preview is live!

🌍 Preview https://staging.overturemaps.org/schema/pr/645/schema/index.html
🕐 Updated Aug 07, 2026 17:23 UTC
📝 Commit a334e62
🔧 env SCHEMA_PREVIEW true

Note

♻️ This preview updates automatically with each push to this PR.

@lowlydba
John McCall (lowlydba) merged commit d2af35e into main Aug 11, 2026
16 checks passed
@lowlydba
John McCall (lowlydba) deleted the bot-label-changelog-skip branch August 11, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation 🦾 Change/enhance automation of a process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CHORE] Skip changelog fragment check for bot-labeled PRs

4 participants