Skip to content

Commit

Permalink
Add new release notes generator to procedure docs (#320)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsimansk authored Jul 18, 2024
1 parent 8f890e6 commit fa28d47
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions PROCEDURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,15 @@ You can manually trigger a release for a repository by re-running its release jo

Repos that don't require release artifacts (such as release tags and GitHub release for example) naturally don't need a release note and this step can be skipped for those. All of the [supporting repos](PROCEDURES.md#supporting-repos) fit these criteria.

#### Github's release notes generator

There's an org wide release notes [template](https://github.com/knative/.github/blob/main/.github/release.yml) configured to enable Github's native [release notes generator](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#example-configurations). Navigate to repository's releases, `edit` newly created release. In the edit view click `Generate release notes`, content is added to release body. In addition, you can check latest new tag is recognized, or correct it accordingly.


#### Alternative release notes generator

This is a former way we used to generate release notes, still usable as a fallback.

To create release note for each repo, run the [Release Notes workflow](https://github.com/knative/release/actions/workflows/release-note.yaml). Afterwards the release note markdown will be a downloadable artifact.

## Releasing a new version of the Knative documentation
Expand Down

0 comments on commit fa28d47

Please sign in to comment.