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

Adding release cut onboarding handbook #2731

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

Conversation

mbianchidev
Copy link
Member

This PR is the result of merging my onboarding notes and a HackMD provided during my first release cut.

What type of PR is this:

/kind documentation
/priority important-longterm

What this PR does / why we need it:

This is part of a bigger plan to document release engineering processes meanwhile I get onboarded in the team.
The doc is meant to be scoped to just cover a release cut and provide a step by step guide to perform it.

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

CC: @jimangel

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Feb 19, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mbianchidev
Once this PR has been reviewed and has the lgtm label, please assign justaugustus for approval. For more information see the 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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/release-eng Issues or PRs related to the Release Engineering subproject labels Feb 19, 2025
@k8s-ci-robot k8s-ci-robot added sig/release Categorizes an issue or PR as relevant to SIG Release. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 19, 2025
@mbianchidev
Copy link
Member Author

/hold until this gets more eyes on it and some consensus

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 19, 2025
@mbianchidev mbianchidev self-assigned this Feb 19, 2025
@puerco
Copy link
Member

puerco commented Feb 19, 2025

Thanks for the update to the docs Matteo, updates to docs are always needed and welcome! Note, however, that this is duplicating the image promotion docs and the branch manager handbook (check the Releases Management section). So I think it's better if we update the kpromo docs and the handbook based on your notes.

@mbianchidev
Copy link
Member Author

mbianchidev commented Feb 21, 2025

Thanks for the update to the docs Matteo, updates to docs are always needed and welcome! Note, however, that this is duplicating the image promotion docs and the branch manager handbook (check the Releases Management section). So I think it's better if we update the kpromo docs and the handbook based on your notes.

Thanks for the review! @puerco

Note: As I am currently onboarding I surely lack the context and historical reasons behind the choice of having those as fragmented docs.

I found (and still find) them to be a tiny bit difficult to navigate as a new contributor and more focused on giving a general overview on the process rather than a straightforward step by step guide to actually perform a release cut.
Now, I also agree that some of the content is lacking on this PR and could definitely be integrated with the existing content.
I don't think that operating the other way around would be beneficial for new contributors.

The option I find viable are the following:

1. Integrating and substituting

Integrate the existing content in this new handbook so that it can become a more complete guide focused just on release cuts (including a step by step guide) - and linking it back in the branch manager handbook as follows:

## Releases Management

[...]

### Release cut complete guide

You can find a step by step buide [here](/handbooks/k8s-release-cut.md)

I have no opinion on temporarily duplicating some of the content and initially keep it in both places, but in the long term I think it would be better to have smaller focused and step by step guides and kind of "breaking down" the current branch manager handbook in smaller, more digestible chunks.

2. Just linking

Linking this new guide as it is in the references section of the branch manager handbook and remove legacy links as follows:

## References
- [Release Tools Documentation](https://github.com/kubernetes/release/blob/master/README.md)
- [Release cut step by step guide](/handbooks/k8s-release-cut.md)

Let me know what you think!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/release Categorizes an issue or PR as relevant to SIG Release. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants