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

Merged
merged 3 commits into from
Oct 7, 2024
Merged

Add One Pager for the Release Signal Handbook #2615

merged 3 commits into from
Oct 7, 2024

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

pacoxu
pacoxu reviewed Sep 9, 2024
View reviewed changes
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!

drewhagen
drewhagen reviewed Sep 10, 2024
View reviewed changes
release-team/release-team.svg Outdated
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 :)

Copy link
Member Author

Choose a reason for hiding this comment

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

What do you use to update these .svgs?

I cherry-picked @pacoxu 's commit, but the SVG file opens as XML (IIRC), so you should be able to update it that way. (There should be some automatic tools too)

We could probably remove those and link Release Signal to this one :)

Done, thanks for noticing it.

@drewhagen
Copy link
Member

drewhagen commented Sep 10, 2024 •
edited
Loading

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 :)

drewhagen
drewhagen reviewed Sep 10, 2024
View reviewed changes
release-team/role-handbooks/release-signal/one-pager.md Outdated
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 •
edited
Loading

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

drewhagen
drewhagen reviewed Sep 10, 2024
View reviewed changes
release-team/role-handbooks/release-signal/one-pager.md
## 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?

Copy link
Member Author

Choose a reason for hiding this comment

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

The flowchart is titled as the testgrid observation cycle, but it largely covers what to do after observing something. Since it all starts with testgrid observation, that's why I named it that. Open to better names :)

Copy link
Member

Choose a reason for hiding this comment

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

I think the name works! I wanted to double check

@drewhagen
Copy link
Member

drewhagen commented Sep 10, 2024 •
edited
Loading

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 k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 23, 2024
@Vyom-Yadav
Copy link
Member Author

I made some changes based on the feedback via review comments and the doc curated by Wendy. Thanks @wendy-ha18 @drewhagen @pacoxu for the reviews. This is ready for another round (hopefully last) of reviews.

@Vyom-Yadav
Copy link
Member Author

the CI Signal process should probably be moved sooner in the visual release path.

The visual release path needs to be updated (+1 on that). I think that would be less detailed (covering high level stuff) than the one pager. Let's keep it for a separate PR.

@drewhagen
Copy link
Member

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 24, 2024
@pacoxu
Copy link
Member

pacoxu commented Sep 24, 2024

/approve
/assign @fsmunoz

@wendy-ha18
Copy link
Member

wendy-ha18 commented Sep 24, 2024 •
edited
Loading

/lgtm
/approve
Thanks @Vyom-Yadav

@Vyom-Yadav
Copy link
Member Author

/assign @fsmunoz

Please unhold and merge.

@fsmunoz
Copy link
Contributor

fsmunoz commented Oct 7, 2024

Looks great, thank you!

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: drewhagen, fsmunoz, pacoxu, Vyom-Yadav, wendy-ha18

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 7, 2024
@Vyom-Yadav
Copy link
Member Author

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 7, 2024
@k8s-ci-robot k8s-ci-robot merged commit 02b6973 into kubernetes:master Oct 7, 2024
1 of 2 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.32 milestone Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pacoxu pacoxu pacoxu left review comments

@drewhagen drewhagen drewhagen approved these changes

@furkatgofurov7 furkatgofurov7 Awaiting requested review from furkatgofurov7

@hailkomputer hailkomputer Awaiting requested review from hailkomputer

@wendy-ha18 wendy-ha18 Awaiting requested review from wendy-ha18

Assignees

@fsmunoz fsmunoz

@justaugustus justaugustus

@pacoxu pacoxu

@drewhagen drewhagen

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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. 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
Milestone
v1.32
Development

Successfully merging this pull request may close these issues.

Create a one-pager for the release signal handbook
7 participants
@Vyom-Yadav @wendy-ha18 @drewhagen @pacoxu @fsmunoz @k8s-ci-robot @justaugustus