chore: make chore/refactor/docs/style commits release-worthy - #94
Merged
Conversation
release-please's default changelog-sections hide chore/refactor/docs/style, and that same hidden flag decides whether a commit is user-facing. With no sections configured, every commit since v0.3.2 was invisible and no release PR was ever opened. Un-hide them (mirroring home-operations/kopiur) and retype Renovate's commits to deps: so auto-merged dependency bumps stay hidden and don't each cut a patch release.
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
1 participant
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.
Release-please has been running green on every push to main but never opening a release PR. It was not broken — it was correctly reporting
No user facing commits found since 666318f - skipping.Root cause
release-please-config.jsondeclared nochangelog-sections, so it inherited the defaults, wherechore,refactor,docsandstylearehidden: true. That samehiddenflag is what decides whether a commit is user-facing, i.e. whether it warrants a release at all — not just whether it shows up in the changelog. Every commit landed on main sincev0.3.2has been achore:orrefactor:, so there was never anything for release-please to propose.home-operations/kopiuropens release PRs for these commits because it ships an explicitchangelog-sectionsblock that un-hides them. This mirrors that.Changes
release-please-config.json— addchangelog-sections, un-hidingfeat/fix/perf/revert/docs/style/chore/refactor, and keepingtest/build/ci/depshidden.renovate.json— setsemanticCommitType: deps(and drop the scope) so dependency bumps land asdeps: ...rather thanchore(deps): .... Without this, un-hidingchorewould make every auto-merged Renovate PR user-facing and cut a patch release, publishing to crates.io and ghcr each time.Verification
release-please release-pr --dry-runagainst this branch now builds a candidatev0.3.3containing #92 and #93, and updatesCHANGELOG.md,Cargo.toml,Cargo.lockand.release-please-manifest.json. The same command againstmainskips.Merging this makes the Release workflow open a
v0.3.3release PR; merging that cuts the tag, GitHub Release, binaries, crates.io publish and ghcr image.Note
Renovate
vulnerabilityAlertsbumps are nowdeps:-typed and therefore hidden too, so a security dependency bump will not cut a release on its own — it rides along with the next release. Flipdepstohidden: falseif you would rather ship those immediately.