Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new release notes generator to procedure docs #320

Merged
merged 1 commit into from
Jul 18, 2024
Merged

Add new release notes generator to procedure docs #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions PROCEDURES.md
View file
Open in desktop
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