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 #281

Merged

Conversation

dsimansk
Copy link
Contributor

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

Preview in markdown format:

<!-- 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

Copy link

knative-prow bot commented Jul 17, 2024

@dsimansk: GitHub didn't allow me to request PR reviews from the following users: knative/knative-release-leads, knative/technical-oversight-committee.

Note that only knative-extensions members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

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

Preview in markdown format:

<!-- 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

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.

@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

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

@knative-prow knative-prow bot requested review from a team, davidhadas and Cali0707 and removed request for a team July 17, 2024 13:00
@psschwei
Copy link
Contributor

+1 from me

@Leo6Leo
Copy link

Leo6Leo commented Jul 17, 2024

+1, it looks good!

@dprotaso
Copy link
Contributor

/lgtm
/approve

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jul 17, 2024
Copy link

knative-prow bot commented Jul 17, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dprotaso, 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 merged commit 8ee09d0 into knative-extensions:main Jul 17, 2024
3 checks passed
@dsimansk dsimansk deleted the pr/release-notes-template branch July 18, 2024 09:02
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. lgtm Indicates that a PR is ready to be merged. 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
4 participants