publish-release: Support adding release notes from a file #2403
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new flag to publish-release: `--release-notes-file` When pointed to a Markdown file, this flag will read its contents and include it in the default release page template. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
k8s-ci-robot
added
release-note
k8s-ci-robot
added
sig/release
saschagrunert
approved these changes
Jan 27, 2022
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: puerco, saschagrunert The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind feature
What this PR does / why we need it:
This commit adds a tiny new feature to
publish-release. It introduces a new flag to thegithubsubcommand:--release-notes-fileWhen pointed to a Markdown file, this flag will read its contents and include it in the default release page template.
It also removes the assets list from the default template as the information is mostly intended for machines and the hashes are already published in the SBOM produced with the release.
Signed-off-by: Adolfo García Veytia (Puerco) [email protected]
Which issue(s) this PR fixes:
None
Special notes for your reviewer:
For a sample of the new release page, check out the v0.2.0 release of
bom:https://github.com/kubernetes-sigs/bom/releases/tag/v0.2.0
Does this PR introduce a user-facing change?