Repository navigation
ci(deps): list dependency updates under Maintenance in the changelog - #273
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…guidance Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The PR title workflow still rejects the new deps prefix, causing Composer and GitHub Actions Dependabot PRs to fail the check until its allowed-type pattern and diagnostic message are updated.
1 open issue
What changed in this PR
This PR gives Dependabot updates a dedicated deps: type so Release Please lists them under Maintenance rather than Added.
Changes:
- Set the
depscommit-message prefix for Composer and GitHub Actions updates. - Add a visible Maintenance changelog section while keeping
chorehidden. - Document the new type and its expected patch-version behaviour.
| File | Description |
|---|---|
release-please-config.json |
Map deps to the visible Maintenance section. |
docs/development.md |
Add deps: to the changelog section reference. |
CONTRIBUTING.md |
Document dependency updates and expected versioning. |
.github/dependabot.yml |
Set both ecosystems to use the deps prefix. |
Review effort: Balanced
| # Without an explicit prefix Dependabot copies the style of recent commits | ||
| # and ends up with "feat(deps)", which shows up under "Added". | ||
| commit-message: | ||
| prefix: deps |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The guide permits plain merges that can omit deps: PRs with non-conventional commits from the changelog, so it should retain the squash-merge requirement and require the valid PR title as the squash commit message.
2 open issues
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
Dependency updates currently show up under Added in the changelog (see the 0.29.0 release PR), because Dependabot copies the style of recent commits and titles its PRs
feat(deps): .../feat(deps-dev): .... That also triggers a minor version bump and theFeaturelabel for plain dependency bumps.Changes
.github/dependabot.yml: setcommit-message.prefix: depsfor the composer and github-actions ecosystems, so PRs are titleddeps: ....release-please-config.json: new changelog sectiondeps-> Maintenance (visible).chorestays hidden, so linter upgrades and similar chores do not clutter the release notes.CONTRIBUTING.mdanddocs/development.md: document thedeps:type.Notes
depsis a releasable type in Release Please, so it causes a patch bump instead of a minor bump.PR Titlecheck from ci: check PR titles for Conventional Commits #269 must accept thedepstype, otherwise Dependabot PRs would fail it. That is handled in ci: check PR titles for Conventional Commits #269.Testing
release-please-config.jsonparses as valid JSON.trunk checkon the four changed files reports no issues.