-
Notifications
You must be signed in to change notification settings - Fork 6
Description
Component
Development Environment
Bug Description
Two issues with the release-please configuration prevent a correct v0.1.0 release:
-
CHANGELOG.md YAML frontmatter breaks markdown linting - The
CHANGELOG.mdfile contained YAML frontmatter (---delimiters). When release-please prepends generated release notes, content is inserted above the frontmatter, causing markdown lint failures in PR chore(main): release 1.0.0 #140. -
release-please produces version 1.0.0 instead of 0.1.0 - Despite
bump-minor-pre-major: trueinrelease-please-config.json, the auto-generated PR chore(main): release 1.0.0 #140 targets version1.0.0. This is a known release-please bug (googleapis/release-please#2087) where a0.0.0initial version in the manifest causes the initial version calculation to bypassbump-minor-pre-majorlogic entirely.
Steps to Reproduce
- Merge feature/fix commits into
mainwithrelease-please-config.jsonset tobump-minor-pre-major: true - Observe release-please auto-generates PR chore(main): release 1.0.0 #140 with version
1.0.0 - Observe markdown linting fails on the generated
CHANGELOG.mdcontent
Expected Behavior
- release-please should produce version
0.1.0(minor bump under pre-major configuration) CHANGELOG.mdshould pass markdown linting after release-please prepends release notes
Logs / Error Output
PR #140 (chore(main): release 1.0.0) fails CI linting checks due to malformed CHANGELOG.md content placed above YAML frontmatter.
Fix
- Strip YAML frontmatter from
CHANGELOG.md, use HTML comment for markdownlint directives, change heading to# Changelog(H1) - Change
release-please-manifest.jsonfrom"0.0.0"to"0.0.1"as the workaround for Initial version 0.0.0 means pre-major options are not respected googleapis/release-please#2087
Checklist
- I have searched existing issues for duplicates
- I have read the documentation