Kubernetes Release Notes

Start the draft.

Following the documentation, we start the pull request.

$ export GITHUB_TOKEN=<...>
$ export PATH=$PATH:~/go/bin
$ krel release-notes --create-draft-pr --fix --fork fsmunoz --list-v2 --tag v1.29.0-alpha.1

It asks us if we want to start, and we confirm:

Reviewing the notes

This will start an interactive process in which each note is shown. We should have defined EDITOR to our preferred editor.

It will asks us if we wanto to fix it; it defaults to No, so we should read the note and determine if we want to change anything: if so, presy Y.

Editing notes

In the editor, we should now edit the text of the note. Some typical points:

• Past tense should be used: if there's an "add foo" this should be changed to "added foo".
• Starting backticked words outside of quoted environment: if something starts like `kubectl`: added foo" , it should start woth a quoted environment like |- - check the discussion of tha alpha.1 PR

Finish the process:

When you're done, it asks if the PR should be created. If you're satisfied with it, say yes.

You should now fo to the PR URL and check it.

PR-level discussion and reviews.

The PR is opened, but that doesn't mean that changes are closed: what we did up until this point was to change things to make them the baseline for the draft PR; the PR discussion process can continue with more suggestions and changes, until it's approved.

If you are reviewing, please try to use GitHub for suggestions, specifically the feature that makes suggestions easily accepted: check the official documentation for instructions. This greatly simplifies the work of the author, and also add you as an author to the commit by default.