Define custom categories for the auto-generated release notes #3921
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
tekton-robot
added
the
kind/misc
tekton-robot
added
the
size/S
|
/hold |
tekton-robot
added
the
do-not-merge/hold
Define custom categories matching the existing release note sections so that the auto-generated release notes more closely match the desired format. Any items appearing in the 'Other changes to review' category should be reviewed to determine if they should be included, and if so should be manually moved to the appropriate category. Unfortunately it's not possible to include custom header / footer content, e.g. our attestation or thanks sections, in the auto-generated release notes so we can't use this approach to produce the complete document. However, there is an API we can call to generate these release notes and use the returned content as part of another automation. This will be based on the `release-draft` Pipeline from the plumbing repo and delivered in a separate change. In the meantime, this change still reduces the amount of manual effort required to create a new release.
AlanGreene
force-pushed
the
release_autogen_categories
branch
from
09108e9 to
916805e
Compare
|
/hold cancel |
tekton-robot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: briangleeson 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 |
tekton-robot
added
the
approved
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.
Changes
Define custom categories matching the existing release note sections so that the auto-generated release notes more closely match the desired format.
Any items appearing in the 'Other changes to review' category should be reviewed to determine if they should be included, and if so should be manually moved to the appropriate category.
Unfortunately it's not possible to include custom header / footer content, e.g. our attestation or thanks sections, in the auto-generated release notes so we can't use this approach to produce the complete document. However, there is an API we can call to generate these release notes and use the returned content as part of another automation. This will be based on the
release-draftPipeline from the plumbing repo and delivered in a separate change.In the meantime, this change still reduces the amount of manual effort required to create a new release.
/kind misc
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
/kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tepRelease Notes