Skip to content

fix: include chore commits in changelog#379

Merged
davidpoblador merged 1 commit into
mainfrom
fix/include-chore-in-changelog
Nov 6, 2025
Merged

fix: include chore commits in changelog#379
davidpoblador merged 1 commit into
mainfrom
fix/include-chore-in-changelog

Conversation

@davidpoblador

Copy link
Copy Markdown
Member

Summary

Added chore commit type to Release Please changelog configuration.

Changes:

  • Added chore type to changelog-sections in .release-please-config.json
  • Chore commits will now appear under "Miscellaneous Chores" section in release notes

This ensures maintenance tasks like dependency updates are documented in releases.

Test plan

Context

Previously, chore commits (like PR #374 "chore(deps): update JavaScript and Python dependencies" and PR #375 "chore: add permissions") were excluded from release notes. This change makes them visible to users so they can see what maintenance work was done.

Common chore commits include:

  • Dependency updates
  • CI/CD configuration changes
  • Repository maintenance
  • Build system updates

🤖 Generated with Claude Code

Added "chore" commit type to changelog-sections configuration.
Chore commits (dependencies, maintenance tasks, etc.) will now
appear under "Miscellaneous Chores" section in release notes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Nov 6, 2025

Copy link
Copy Markdown

Claude finished @davidpoblador's task —— View job


PR Review Complete ✅

Reviewing PR #379: "fix: include chore commits in changelog"

Todo List:

  • Read and analyze the modified .release-please-config.json file
  • Review the configuration change for correctness and best practices
  • Assess potential impact and compatibility
  • Provide comprehensive review feedback

Review Feedback

This is a well-implemented and necessary change that improves the project's release documentation. Here's my detailed analysis:

✅ Code Quality & Best Practices

  • JSON syntax: Perfect - valid JSON with proper formatting and structure
  • Configuration structure: Follows Release Please schema correctly
  • Naming consistency: Uses standard conventional commit type chore with appropriate section name "Miscellaneous Chores"
  • Placement: Logically positioned at the end of the changelog sections array

✅ Correctness & Compatibility

  • Release Please compatibility: This change is fully compatible with Release Please v15+
  • Schema compliance: The configuration follows the official Release Please JSON schema
  • Conventional commits alignment: Perfectly aligns with the repository's documented commit types in CLAUDE.md:24

✅ Business Logic & Impact

🔍 Potential Considerations

  1. Changelog verbosity: Including chore commits will make changelogs longer. However, this is likely beneficial for transparency about maintenance work.

  2. Section ordering: Consider if "Miscellaneous Chores" should appear before "Performance Improvements" to group maintenance items together. Current order is fine but could be optimized for readability.

🛡️ Security & Performance

  • No security concerns: This is a pure configuration change with no security implications
  • No performance impact: Release Please processes this configuration only during release creation
  • No runtime effects: This only affects generated changelog content

🧪 Test Coverage

  • Configuration validation: Author confirmed JSON schema compliance ✅
  • Integration testing: The change will be validated when Release Please processes the next release
  • Recommendation: After merge, verify that chore commits appear correctly in the next Release Please PR

📝 Suggestions for Future Improvements

  1. Consider documenting the complete changelog section configuration in CONTRIBUTING.md
  2. The repository could benefit from a .release-please-manifest.json for version tracking consistency

Final Assessment

APPROVE - This is a clean, necessary change that:

  • Fixes a legitimate gap in release documentation
  • Follows all established patterns and conventions
  • Has zero risk and clear benefits
  • Is properly tested and documented

The change directly addresses the issue described in the PR and aligns perfectly with the repository's Release Please workflow.


@davidpoblador davidpoblador merged commit 44ffea3 into main Nov 6, 2025
2 checks passed
@davidpoblador davidpoblador deleted the fix/include-chore-in-changelog branch November 6, 2025 10:36
davidpoblador pushed a commit that referenced this pull request Nov 6, 2025
🤖 I have created a release *beep* *boop*
---


##
[2.13.5](v2.13.4...v2.13.5)
(2025-11-06)


### Bug Fixes

* convert relative links to absolute URLs in changelog docs
([#373](#373))
([a3ab5cb](a3ab5cb))
* include chore commits in changelog
([#379](#379))
([44ffea3](44ffea3))
* include refactor and perf commits in changelog
([#378](#378))
([f98e9df](f98e9df))


### Code Refactoring

* remove template backwards compatibility symlink
([#377](#377))
([3ba7e11](3ba7e11))


### Miscellaneous Chores

* add gh pr list and gh run list permissions
([#380](#380))
([6fb0642](6fb0642))
* add permissions for uvx uv-bump and gh pr create
([#375](#375))
([27e392a](27e392a))
* **deps:** update JavaScript and Python dependencies
([#374](#374))
([0370036](0370036))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

1 participant