Skip to content

Fix changelog fragment PR check#699

Merged
baogorek merged 1 commit intomainfrom
fix/changelog-fragments
Apr 7, 2026
Merged

Fix changelog fragment PR check#699
baogorek merged 1 commit intomainfrom
fix/changelog-fragments

Conversation

@anth-volk
Copy link
Copy Markdown
Collaborator

Fixes #698

Summary

  • Replace the recursive changelog.d file count with Towncrier diff-aware checking against origin/main.
  • Remove stale nested changelog fragments that made PRs without new fragments pass the old check.
  • Add a top-level changelog fragment for this fix.

Test plan

  • git diff --check
  • Parsed .github/workflows/pr.yaml as YAML
  • uv run --no-sync towncrier check --compare-with origin/main

@anth-volk anth-volk requested a review from baogorek April 7, 2026 16:42
@anth-volk
Copy link
Copy Markdown
Collaborator Author

@baogorek would love review on this following merge of #697. This should prevent the versioning skip we had on #684.

@anth-volk anth-volk marked this pull request as ready for review April 7, 2026 17:40
Copy link
Copy Markdown
Collaborator

@baogorek baogorek left a comment

Choose a reason for hiding this comment

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

Looks good — the core fix is correct and towncrier check --compare-with origin/main is the right replacement for the naive file count.

Two minor notes (not blocking):

  1. 553.md and 589.md are unconsumed — their text never made it into CHANGELOG.md despite multiple version bumps since they were added. Deleting them won't break anything, but those changelog entries will be lost permanently. They also don't need to be deleted for the fix to work, since towncrier check --compare-with origin/main only looks at the diff.

  2. uv sync --dev is heavy for this job — it installs the full dev dependency tree just to run towncrier. Something like pip install towncrier>=24.8.0 or uvx towncrier check would be faster.

@baogorek baogorek merged commit 9a54a8d into main Apr 7, 2026
9 checks passed
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.

Fix changelog fragment PR check

2 participants