Skip to content

chore(release): configure generated notes taxonomy - #1894

Merged
clairernovotny merged 2 commits into
mainfrom
codex/docs-release-note-taxonomy
Jul 31, 2026
Merged

chore(release): configure generated notes taxonomy#1894
clairernovotny merged 2 commits into
mainfrom
codex/docs-release-note-taxonomy

Conversation

@clairernovotny

@clairernovotny clairernovotny commented Jul 30, 2026

Copy link
Copy Markdown
Member

Summary

Generated release notes now group user-facing changes into breaking changes, features, fixes, and documentation while excluding maintenance and explicitly omitted entries. Dependency-labeled changes remain visible so mixed security or bug-fix updates are not silently dropped.

Validation

  • Parsed the YAML and validated the expected GitHub schema shape.
  • Confirmed every configured label exists in the repository.
  • Confirmed dependency-labeled entries are not globally excluded.
  • git diff --check

Checklist

  • Implementation is clean.
  • Repository coding standards are followed.
  • No code-analysis warnings are introduced.
  • No executable unit coverage is applicable to this configuration-only change.
  • No copied code requires attribution.
  • No explanatory code comments or XML documentation are applicable.
  • Rebased on the latest origin/main.
  • No issue is closed by this independent configuration change.
  • No README update is needed.
  • Applicable documentation/release validation was run.

Copilot AI review requested due to automatic review settings July 30, 2026 19:10
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Chores
    • Added automated release note configuration for more consistent changelog generation.
    • Release notes are categorized as Breaking Changes, Features, Fixes, or Documentation based on change labels.
    • Maintenance and no-release-note changes are excluded from generated release notes, keeping published updates focused on meaningful product changes.

Walkthrough

Adds GitHub release configuration that excludes selected labels from changelogs and groups remaining entries into breaking changes, features, fixes, and documentation.

Changes

Release Notes

Layer / File(s) Summary
Changelog classification rules
.github/release.yml
Configures excluded labels and release note categories for breaking changes, features, fixes, and documentation.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A rabbit sorts the labels bright,
Hiding maintenance from release light.
Features hop, fixes dash,
Docs unfold in a leafy flash,
While breaking changes thump just right!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title clearly summarizes the release-note taxonomy configuration.
Description check ✅ Passed The description directly explains the release-note grouping, exclusions, dependency handling, and validation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-release-note-taxonomy

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.

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

Configures GitHub-generated release notes taxonomy for the Humanizer repository by grouping PRs into user-facing categories while excluding maintenance- and dependency-only changes.

Changes:

  • Adds .github/release.yml to define release-note categories: Breaking changes, Features, Fixes, and Documentation.
  • Configures exclusions to omit PRs labeled no release notes, maintenance, or dependencies from generated notes.
  • Uses existing repository labels to drive categorization while leaving unclassified entries ungrouped (no guessing).

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a493263567

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/release.yml Outdated
@clairernovotny
clairernovotny merged commit d89bb96 into main Jul 31, 2026
17 checks passed
@clairernovotny
clairernovotny deleted the codex/docs-release-note-taxonomy branch July 31, 2026 19:18
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