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 release notes document #3947

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add release notes document #3947

wants to merge 2 commits into from

Conversation

johngmyers
Copy link
Contributor

Description

This is a proposal for a procedure to collect release notes.

The items in the "Other changes" section might be giving too much detail.

Fixes #3925

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 20, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from johngmyers. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@johngmyers
Copy link
Contributor Author

/cc @Raffo
/cc @mloiseleur

@mloiseleur
Copy link
Contributor

This is clearly nice and readable.
As long as we don't ask all PR authors to update it, maybe it can work.
At least, we can try.
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 22, 2023
@johngmyers johngmyers changed the title WIP add release notes document Add release notes document Sep 27, 2023
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 27, 2023
@Raffo
Copy link
Contributor

Raffo commented Oct 6, 2023

@johngmyers can you add some more info on who's supposed to edit the release notes ? Is it the author of a PR or is it us maintainers? If the PR author, how do we ensure programmatically that the release notes are there? And what do we do with them at release time? Copy them instead of the automatically generated release notes or prepend those to avoid missing information? I think with more clarifications we can make the process of contributors, reviewers and people drafting release a bit better.

@johngmyers
Copy link
Contributor Author

I'm basing this loosely on what we do for kubernetes/kops. Ultimately it's up to the maintainers to make sure it has necessary information, but it's reasonable for reviewers/approvers to ask authors to include a release note in the PR.

The notes should be built up as we go so we don't have to do a big edit job at release time. I don't think we're at a volume where we need to do this programmatically.

In kops we prepend the release notes to the automatically generated changelog for minor releases. Patch releases only have the automatically generated changelog, as such releases only have cherrypicks.

@Raffo
Copy link
Contributor

Raffo commented Oct 11, 2023

Ok, cool. Can you add that information that you posted here to the release process document so that's easy to know what to do?

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 15, 2023
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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/test-infra repository.

kundan2707
kundan2707 reviewed Nov 28, 2023
View reviewed changes
Copy link
Contributor

@kundan2707 kundan2707 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v0.14 already release so please update release notes with latest one

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 26, 2024
@mindw
Copy link

mindw commented Mar 22, 2024

/remove-lifecycle stale

The release text is limited in size and is cut mid way.
Having the autogenerated release notes dumped to a file sorted by type would be a great help!.

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 22, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 20, 2024
@mindw
Copy link

mindw commented Jun 20, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 20, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 18, 2024
@mindw
Copy link

mindw commented Sep 20, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kundan2707 kundan2707 kundan2707 left review comments

@njuettner njuettner Awaiting requested review from njuettner

@szuecs szuecs Awaiting requested review from szuecs

@mloiseleur mloiseleur Awaiting requested review from mloiseleur

@Raffo Raffo Awaiting requested review from Raffo

Assignees

@mloiseleur mloiseleur

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve release notes readability
7 participants
@johngmyers @k8s-ci-robot @mloiseleur @Raffo @k8s-triage-robot @mindw @kundan2707