Skip to content

ci(release): preserve and generate Breaking Changes sub-bullets - #413

Merged
Calvin-Cheng1 merged 4 commits into
mainfrom
ci/release-breaking-changes-sub-bullets
Nov 12, 2026
Merged

Calvin-Cheng1 merged 4 commits into
mainfrom
ci/release-breaking-changes-sub-bullets

Conversation

@aghassemlouei

@aghassemlouei aghassemlouei commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

Description

Extracts Release Please automation out of inline YAML heredocs in .github/workflows/release.yml into tools/release_please.py with direct unit test coverage in tests/test_release_please.py so rolling Release Please pull requests generate and preserve human-readable * ... sub-bullets across ### Breaking Changes, ### Features, and ### Bug Fixes:

  • Reduces .github/workflows/release.yml from 447 lines of inline Python, sed, and Node.js heredocs to 66 declarative lines calling tools/release_please.py prepare and tools/release_please.py label-pr so ruff, tools/check_boilerplate.py, and direct Python imports cover all release-note logic without YAML string slicing or exec().
  • Appends trailing commit SHA hyperlinks to ### Breaking Changes entries in template1.hbs via atomic, fail-closed _replace_exact checks and intentionally removes legacy release-please--branches--main compatibility shims now that #394 is merged and v6.0.0 is tagged.
  • Tracks section-scoped breaking:<sha7> vs <sha7> keys in extract_existing, matches optional , closes [#N](...) commit-reference suffixes, and switches fs.readFileSync to require('fs').readFileSync inside the bundled DefaultChangelogNotes webpack module so saved sub-bullets load cleanly and feat!: or fix!: commits retain distinct migration vs capability sub-bullets across pushes.
  • Computes missing sub-bullets once in collect_sub_bullets when RELEASE_PAT is set by resolving pulls/{number} from (#NNNN) commit subjects before commits/{sha}/pulls for large squash commits such as #311, honoring multi-sentence <!-- breaking-note: ... --> overrides without duplicating BREAKING CHANGE: footers already rendered as parent bullets, joining wrapped ## Description paragraphs, and stripping @username mentions while preserving scoped packages and Python decorators.

No separate GitHub issue exists; follows up on #365, #394, and #410.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Deployment & Compliance Impact

  • Applicable Regimes:
    • US Region Restricted (e.g., Access Policy constraint)
    • FedRAMP Moderate
    • FedRAMP High
    • DoD IL4
    • DoD IL5
    • General / All
  • NIST 800-53r5 Controls: None. Updates repository release-note tooling, workflow configuration, and unit test coverage only.

Checklist

Code Quality & Reusability

  • My code adheres to the Maximize Reusability principle. I have not redefined common elements and have reused existing base configurations and modules where possible.
  • I have checked that no existing module or configuration in modules/ or fast/stages-aw/ can be leveraged for this change.
  • My code follows the established naming conventions outlined in docs/naming-convention.md.

Documentation

  • I have updated the README.md of the modified module or blueprint.
  • I have added/updated documentation for inputs (variables) and outputs.

Security

  • My change adheres to GCP security best practices and the principle of least privilege.
  • I have ensured compliance with the targeted regime (FedRAMP Moderate, FedRAMP High, IL4, IL5, etc.).

Testing

  • I have tested my changes locally.
  • I have included details of my testing in this PR.

Testing Performed

  • Executed bash tools/run_tests.sh and uv run --locked pytest across tests/test_release_please.py and tests/test_label_taxonomy.py covering template1.hbs commit-SHA links, section-scoped Breaking Changes vs Features sub-bullet preservation, , closes commit-reference matching across CHANGELOG.md, non-duplicated BREAKING CHANGE: footers, require('fs') webpack scope isolation, atomic fail-closed anchor checks, wrapped ## Description extraction, and commit-subject PR lookup fallback.
  • Verified uv run --locked ruff format --check ., uv run --locked ruff check ., and uv run --locked python tools/check_links.py --no-show-summary . across the repository.
  • Validated tools/release_please.py against the googleapis/release-please-action v5.0.0 dist/ bundle with Node.js across the v5.2.0...v6.0.0 commit range and 21 adversarial commit, footer, and reference cases, confirming single-dash branch resolution and exact section-scoped sub-bullet rendering.

@aghassemlouei aghassemlouei added Bug Something isn't working Documentation Improvements or additions to documentation Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Medium Standard features and non-blocking bugs; important for the current milestone but not urgent labels Nov 10, 2026
@aghassemlouei aghassemlouei self-assigned this Nov 10, 2026
@aghassemlouei
aghassemlouei force-pushed the ci/release-breaking-changes-sub-bullets branch 2 times, most recently from f577353 to 2fec8fd Compare November 11, 2026 16:55
@aghassemlouei
aghassemlouei force-pushed the ci/release-breaking-changes-sub-bullets branch from 2fec8fd to 1f5dda4 Compare November 11, 2026 17:44
@aghassemlouei
aghassemlouei marked this pull request as ready for review November 11, 2026 17:50
@aghassemlouei
aghassemlouei removed the request for review from LanceWray November 12, 2026 16:23
Comment thread tools/release_please.py Resolved
@Calvin-Cheng1
Calvin-Cheng1 merged commit 80bc712 into main Nov 12, 2026
22 checks passed
@Calvin-Cheng1
Calvin-Cheng1 deleted the ci/release-breaking-changes-sub-bullets branch November 12, 2026 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working Documentation Improvements or additions to documentation Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Medium Standard features and non-blocking bugs; important for the current milestone but not urgent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants