Skip to content

fix(ci): CHANGELOG frontmatter breaks linting and release-please produces 1.0.0 instead of 0.1.0 #141

@WilliamBerryiii

Description

@WilliamBerryiii

Component

Development Environment

Bug Description

Two issues with the release-please configuration prevent a correct v0.1.0 release:

  1. CHANGELOG.md YAML frontmatter breaks markdown linting - The CHANGELOG.md file 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.

  2. release-please produces version 1.0.0 instead of 0.1.0 - Despite bump-minor-pre-major: true in release-please-config.json, the auto-generated PR chore(main): release 1.0.0 #140 targets version 1.0.0. This is a known release-please bug (googleapis/release-please#2087) where a 0.0.0 initial version in the manifest causes the initial version calculation to bypass bump-minor-pre-major logic entirely.

Steps to Reproduce

  1. Merge feature/fix commits into main with release-please-config.json set to bump-minor-pre-major: true
  2. Observe release-please auto-generates PR chore(main): release 1.0.0 #140 with version 1.0.0
  3. Observe markdown linting fails on the generated CHANGELOG.md content

Expected Behavior

  • release-please should produce version 0.1.0 (minor bump under pre-major configuration)
  • CHANGELOG.md should 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

Checklist

  • I have searched existing issues for duplicates
  • I have read the documentation

Metadata

Metadata

Labels

bugSomething isn't workingci/cdCI/CD pipeline and automationpriority-2High: Important, address soonsize-sSmall: 1-4 hours

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions