Investigate GitHub generated release notes
- Dominant language
- Go
- Stars
- 83
- Forks
- 160
- PR merge metrics
- No merged PRs in 30d
Description
There's an API we can use to add notes to a release. The output can be customized using a config file.
https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release
We currently use an action - https://github.com/knative/actions/blob/main/.github/workflows/release-notes.yaml to generate them but they are manually applied on the release
Contributor guide
Research direction
Start by reading .github/workflows/release-notes.yaml and the linked GitHub generate-release-notes API documentation. Determine how the API and its configuration could replace the current manual application of action output; done means the release process applies generated notes without that manual step.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, github-actions
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100