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.

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

Add global release notes template #25

Closed
wants to merge 1 commit into from
Closed

Conversation

dsimansk
Copy link
Contributor

@dsimansk dsimansk commented Jul 17, 2024

Changes

  • 🎁 Add global release notes template

The format is a merge between our common templates we use in release blog and k8s release-notes tool we used so far.

With the template in place, release leads don't have to execute GH action to produce release notes in .md and copy it over. Rather press Generate release notes button in release edit view.
Future enhancement to consider, the process can be further automated with GH API calls, it's not 1 step process, but rather a chain. In a nutshell POST to generate notes with inputs -> content in response -> POST to edit/update release body.

/cc @knative/knative-release-leads
/cc @knative/technical-oversight-committee

Fixes knative/community#1499

Based on docs:
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#example-configurations

Preview from knative/client current main:

Screenshot 2024-07-17 at 14 24 00

@knative-prow knative-prow bot requested review from a team July 17, 2024 12:41
Copy link

knative-prow bot commented Jul 17, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dsimansk

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 17, 2024
@dsimansk
Copy link
Contributor Author

Markdown format of the preview:

<!-- Release notes generated using configuration in .github/release.yml at main -->
## What's Changed
### 💫 New Features & Enhancements
* Add option flags to define nodeSelector, nodeAffinity and toleration on Knative Service by @Shashankft9 in https://github.com/knative/client/pull/1924
### 🛠 Other Changes
* Add release note template by @dsimansk in https://github.com/knative/client/pull/1956

## New Contributors
* @Shashankft9 made their first contribution in https://github.com/knative/client/pull/1924

**Full Changelog**: https://github.com/knative/client/compare/knative-v1.14.0...v0.0.1-release-notes

@Cali0707
Copy link
Member

@dsimansk it looks like the action is failing with:

Error: knative/.github is not the source of truth.  Please send a Pull Request to 'knative-extensions/.github' instead.

@dsimansk
Copy link
Contributor Author

dsimansk commented Jul 17, 2024

@dsimansk it looks like the action is failing with:

Error: knative/.github is not the source of truth.  Please send a Pull Request to 'knative-extensions/.github' instead.

Unexpected plot twist, but makes sense. I thought both knative/.github and knative-extensions/.github are independent. I'll recreate the PR. Thanks for pointer!

@dsimansk
Copy link
Contributor Author

Superseded by SoT PR: knative-extensions/.github#281
/close

@knative-prow knative-prow bot closed this Jul 17, 2024
Copy link

knative-prow bot commented Jul 17, 2024

@dsimansk: Closed this PR.

In response to this:

Superseded by SoT PR: knative-extensions/.github#281
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PROCESS CHANGE: use GitHub native release notes generator
2 participants