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 One Pager for the Release Signal Handbook #2615

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

Conversation

Vyom-Yadav
Copy link
Member

What type of PR is this:

/kind documentation

What this PR does / why we need it:

The Release Signal Handbook is quite long. These diagrams in one pager aim to provide a quick overview of the process to simplify things.

Which issue(s) this PR fixes:

Fixes #2612

Special notes for your reviewer:

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority labels Sep 8, 2024
@k8s-ci-robot k8s-ci-robot added the area/release-team Issues or PRs related to the release-team subproject label Sep 8, 2024
@k8s-ci-robot k8s-ci-robot added sig/release Categorizes an issue or PR as relevant to SIG Release. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 8, 2024
@Vyom-Yadav
Copy link
Member Author

/cc @drewhagen @pacoxu @wendy-ha18
/priority important-soon

These are the initial things that occurred to me. I'm open to adding/removing things to simplify it. Feedback would be appreciated :)

@k8s-ci-robot k8s-ci-robot added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-priority labels Sep 8, 2024
@Vyom-Yadav
Copy link
Member Author

/hold

@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 Sep 8, 2024
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 8, 2024
@Vyom-Yadav
Copy link
Member Author

/assign @justaugustus

Copy link
Member

@pacoxu pacoxu left a comment

Choose a reason for hiding this comment

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

Nice one-pager!
👍
/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 9, 2024
@wendy-ha18
Copy link
Member

Hi @Vyom-Yadav ,

Great effort on this! I initially thought you would create a One Pager similar to the CI Signal One Pager, but I really like the diagram approach you used.

Hope this diagram will be easy to maintain going forward.

I have a few minor suggestions for the diagram. Feel free to review them in this note: One Pager Input. You’re welcome to ignore anything that seems too detailed for the One Pager purpose.

Another point, which might be slightly outside the scope of this PR, before looking at your diagram I have reviewed the Release Path on Release team Handbook (particularly for Release Signal process).

  • Perhaps we should consider updating the CI Signal process (monitoring test grid) in Release team Handbook to start earlier at the beginning of the release cycle, and Bug Triage begins a bit later?
  • Alternatively, we could integrate or adjust them to better align with Signal Process?

Just some thoughts, hope this helps!

Copy link
Member

Choose a reason for hiding this comment

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

Awesome job updating this! What do you use to update these .svgs? I'm curious in case I want to update something myself in the future.

It looks like there is also a table in the release-team doc that uses this .svg that can also be updated. It has links to CI Signal and Bug Triage one pagers. We could probably remove those and link Release Signal to this one :)

@drewhagen
Copy link
Member

drewhagen commented Sep 10, 2024

I agree with @wendy-ha18 - this gets a bit adjacent to your contribution that we're reviewing @Vyom-Yadav, but nonetheless while we're updating the SIG Release README, the CI Signal process should probably be moved sooner in the visual release path. (I think the original thought was that flakes and failures would come out of code development that follows after enhancement freeze? But actually, a lot of tracked flakes, failures and code implementations carry over from past milestones, so test grid observation can begin right away)
It looks like this is mermaid though, so this should be an easy update :)

E --> F["Message #release-signal Slack channel"]
F --> G["Reach out to SIG on Slack"]
G --> H["Ping SIG TLs/Chairs/Active Members"]
H --> I["Ask if it's a blocker for upcoming release"]
Copy link
Member

@drewhagen drewhagen Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
H --> I["Ask if it's a blocker for upcoming release"]
H --> I["Ask if it's a blocker for upcoming release cut"]

credit goes to @wendy-ha18 for this feedback. It makes it a bit more clear to focus the ask on the next upcoming cut.

## Release Signal - Testgrid Observation Loop

```mermaid
flowchart TD
Copy link
Member

Choose a reason for hiding this comment

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

I just want to clarify my interpretation: this flowchart is sort of the lifecycle of an individual flake/failure issue, right?

@drewhagen
Copy link
Member

drewhagen commented Sep 10, 2024

Really great job @Vyom-Yadav! I appreciate you putting this together.

I think these diagrams cover the most frequent day to day operations, which will be really helpful for the team to understand.

This also really compliments the full handbook well, that covers all other tasks with more details. The current handbook is also organized into sections well enough that the lead could always guide shadows by sharing anchor links of sections when less common tasks come up.

@drewhagen
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: drewhagen, Vyom-Yadav
Once this PR has been reviewed and has the lgtm label, please ask for approval from justaugustus. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-team Issues or PRs related to the release-team 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. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a one-pager for the release signal handbook
6 participants