search

cisagov / ScubaGear

Automation to assess the state of your M365 tenant against CISA's baselines
https://www.cisa.gov/resources-tools/services/secure-cloud-business-applications-scuba-project
Creative Commons Zero v1.0 Universal
1.58k stars 213 forks source link

Implement custom release notes template #942

Open schrolla opened 6 months ago

schrolla commented 6 months ago

Each release comes with an auto-generated set of release notes. The default notes, however, aren't formatted exactly as the project wishes. So, implement a custom template for release notes using the built-in GitHub release.yml capability.

_Originally posted by @mitchelbaker-cisa in https://github.com/cisagov/ScubaGear/pull/936#discussion_r1504816804_

mitchelbaker-cisa commented 6 months ago

There's also https://github.com/mikepenz/release-changelog-builder-action which provides more functionality. It would be an additional step in build_release.yaml, output can be passed directly into softprops/action-gh-release which we already use.

I've used it successfully with LME to create a new release workflow https://github.com/cisagov/LME/blob/main/.github/workflows/build_release.yaml