Skip to content

Group tests and deprecations in the changelog - #997

Open
cjbarth wants to merge 1 commit into
masterfrom
changelog-label-groups
Open

cjbarth wants to merge 1 commit into
masterfrom
changelog-label-groups

Conversation

@cjbarth

@cjbarth cjbarth commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

.grenrc.js picks a pull request's changelog section from its labels. This brings it in line with the label scheme now used across xml-crypto, node-saml and passport-saml.

  • New sections: deprecation gets Deprecations, after Minor Changes, and tests gets Tests, after Documentation.
  • Retired names: semver-major, semver-minor, semver-patch and new-feature leave the groups and the hidden-badge list. No merged or open pull request carries them; semver-major became breaking-change and new-feature became enhancement.
  • Hidden badges: the kind badges were already hidden, so tests and deprecation join them, along with Dependabot's javascript and github_actions. security still shows.
  • Duplicates: a pull request labelled duplicate is left out of the changelog, as in xml-crypto.

The labels

Each pull request has one kind: enhancement, deprecation, bug, dependencies, documentation, tests or chore. breaking-change either stands alone or flags a kind, and security flags a kind. Each label's description on GitHub gives its definition.

The pull requests are already relabelled: all 325 merged or open ones have exactly one kind, or breaking-change alone. That includes 96 merged pull requests that had no label, nearly all from 2012 to 2020.

Effect on the changelog

CHANGELOG.md is not regenerated here; the next release does that. In a trial run:

  • all 33 "Other" sections are gone, their entries now under Bug Fixes, Minor Changes and the other sections;
  • test-only pull requests get a Tests section;
  • the pull request that added deprecation notices in v2.2.0 gets a Deprecations section.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated changelog organization to separate breaking changes, enhancements, deprecations, and tests.
    • Adjusted which labels and issue tags are included in generated changelogs.

Give the `tests` and `deprecation` labels their own changelog sections, and drop the label names that no merged or open pull request carries any more.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cjbarth cjbarth added the chore Maintenance with no change in behavior: refactoring, tooling, CI, merges, releases, changelog label Oct 5, 2026
@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a1c20673-0e59-4df4-8d5e-4f8cbee070b5
📥 Commits

Reviewing files that changed from the base of the PR and between 291073e and e84dcd7.

📒 Files selected for processing (1)
  • .grenrc.js

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The changelog configuration updates ignored labels and issue tags, changes mappings for major and minor changes, adds Deprecations and Tests groups, and adds icons for those groups.

Changes

Changelog Configuration

Layer / File(s) Summary
Changelog labels, groups, and icons
.grenrc.js
The ignored-label list and ignored issue tags change. Major Changes and Minor Changes map only to breaking-change and enhancement, respectively. Deprecations and Tests groups and their icons are added.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to e84dc

No actionable changelog-generation issue is established; the change is mergeable under normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to e84dc

The changed surface does not map to a changed system, dependency edge, entrypoint, or external dependency.

Changed systems: None identified.

Architecture concerns
No architecture-level concerns identified.

Review details

Before / after behavior

  • observed — Modified behavior in .grenrc.js: The ignored-label list drops semver-major, semver-minor, semver-patch, and new-feature, and adds deprecation, tests, javascript, and github_actions; ignored issue tags now include duplicate. Grouping removes semver and new-feature mappings, limits Major Changes and Minor Changes to breaking-change and enhancement, and adds Deprecations and Tests groups.
  • observed — Modified behavior in .grenrc.js: The icon map adds icons for the Deprecations and Tests groups.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding Tests and Deprecations sections to the changelog.
Description check ✅ Passed The description summarizes the change, explains its use case across related projects, and reports trial-run results. It does not include the template checklist or state explicitly whether tests are in…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.77%. Comparing base (291073e) to head (e84dcd7).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #997   +/-   ##
=======================================
  Coverage   65.77%   65.77%           
=======================================
  Files           4        4           
  Lines         149      149           
  Branches       37       37           
=======================================
  Hits           98       98           
  Misses         41       41           
  Partials       10       10           

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

Labels

chore Maintenance with no change in behavior: refactoring, tooling, CI, merges, releases, changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant