Skip to content

ci(release): preserve and synthesize release note sub-bullets in release.yml - #365

Merged
aghassemlouei merged 1 commit into
mainfrom
ci/enrich-release-notes
Oct 27, 2026
Merged

aghassemlouei merged 1 commit into
mainfrom
ci/enrich-release-notes

Conversation

@aghassemlouei

Copy link
Copy Markdown
Member

Description

Configures .github/workflows/release.yml to preserve existing * ... release note sub-bullets and synthesize missing sub-bullets before and during googleapis/release-please-action execution:

  • Adds a Prepare Release Sub-Bullets pre-step that extracts existing * ... sub-bullets from CHANGELOG.md and the open release-please--branches--main PR body, synthesizes missing sub-bullets for commits since the last release tag (using secrets.GEMINI_API_KEY when configured, with deterministic fallback to the merged PR ## Description summary), and writes /tmp/release_sub_bullets.json.
  • Patches DefaultChangelogNotes.buildNotes in dist/index.js so release-please injects the mapped `
    • ...sub-bullet beneath each commit entry acrossCHANGELOG.md`, the Release PR description, and the GitHub Release notes produced on merge.
  • Applies curated labels (Documentation, Priority - Low, Level of Effort - Low) alongside Release - Pending whenever a Release PR is opened or updated.

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: N/A (CI release automation configuration and unit test assertions)

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

  • Verified the Prepare Release Sub-Bullets extraction/fallback logic and the DefaultChangelogNotes.buildNotes patch against googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 (dist/index.js) in Node.js 22.
  • Added unit test assertions in tests/test_label_taxonomy.py and verified uv run --locked pytest tests/test_label_taxonomy.py and uv run --locked ruff check pass cleanly.

@aghassemlouei aghassemlouei added Enhancement New feature or request Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits labels Oct 27, 2026
@aghassemlouei
aghassemlouei merged commit 0623eae into main Oct 27, 2026
22 checks passed
@aghassemlouei
aghassemlouei deleted the ci/enrich-release-notes branch October 27, 2026 02:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement New feature or request Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant