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

🌱 Improve weekly PR update generation script and documentation #10092

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

typeid
Copy link
Contributor

@typeid typeid commented Feb 2, 2024

What this PR does / why we need it:
Currently, the usage of the weekly PR update generation script is a bit confusing because it requires checking out the right branches as well as providing the right milestones for these branches. This PR attempts to address this issue by clarifying the documentation and updating the script to only use the branch parameter for the whole flow.

This PR updates the Generate weekly PR updates to post in Slack flow:

  • the script has been updated
    • it now pulls from github instead of needing a local correct checkout and right branch
    • the time range was previously off by a day, this is now fixed
    • --milestone is now --branch and should no more cause confusion between the relationship of branch to milestone
    • a parameter check for --branch was added
  • the documentation was updated
    • added a full example of commands to run during an ongoing release cycle
    • updated the usage to branch instead of milestone

Which issue(s) this PR fixes
Fixes #10008

/area release

@k8s-ci-robot k8s-ci-robot added area/release Issues or PRs related to releasing cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 2, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @typeid. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@typeid typeid changed the title ✨Improve weekly PR update generation script and documentation 🌱 Improve weekly PR update generation script and documentation Feb 2, 2024
@willie-yao
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 2, 2024
Copy link
Contributor

@willie-yao willie-yao left a comment

Choose a reason for hiding this comment

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

Nice work! This will be a great improvement to the current tool 🚀

hack/tools/release/weekly/main.go Outdated Show resolved Hide resolved
hack/tools/release/weekly/main.go Outdated Show resolved Hide resolved
hack/tools/release/weekly/main.go Outdated Show resolved Hide resolved
hack/tools/release/weekly/main.go Outdated Show resolved Hide resolved
hack/tools/release/weekly/main.go Outdated Show resolved Hide resolved
@typeid typeid force-pushed the 10008 branch 2 times, most recently from 0c4dc86 to 710889d Compare February 3, 2024 08:25
@typeid
Copy link
Contributor Author

typeid commented Feb 3, 2024

I'm not fully sure why the lint workflow fails.

@typeid typeid force-pushed the 10008 branch 2 times, most recently from 4d6fea6 to b973c82 Compare February 6, 2024 08:05
Copy link
Contributor

@willie-yao willie-yao left a comment

Choose a reason for hiding this comment

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

/lgtm

Great work!!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 6, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 1bf8e39c2418e59c115a73c266c1e79ff9755e06

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 8, 2024
```bash
./bin/weekly --from YYYY-MM-DD --to YYYY-MM-DD --milestone v1.x
./bin/weekly --since YYYY-MM-DD --until YYYY-MM-DD --branch release-1.x
Copy link
Member

Choose a reason for hiding this comment

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

looks like this generic example is in conflict with the provided examples, specifically the --branch arg: ./bin/weekly --since 2024-01-22 --until 2024-01-28 --branch main

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should be more generic now, thanks for pointing that out Stephen.

@cahillsf
Copy link
Member

cahillsf commented Feb 8, 2024

would you mind pushing a small update to this line too:

fmt.Println("_Thanks to all our contributors!_ 😊")

i think the underscores should be * or something else that highlights this line to bold or italicize, right now they just render in slack as underscores

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 8, 2024
@typeid
Copy link
Contributor Author

typeid commented Feb 8, 2024

/retest

@willie-yao
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 9, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 3d33eb8f1231778c4c4cdc1f89815116b9abfe42

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 9, 2024
@cahillsf
Copy link
Member

very nice! thanks for this update 👍

/lgtm

@sbueringer
Copy link
Member

/approve

(given lgtm's above. I didn't review the code change)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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 Feb 12, 2024
@k8s-ci-robot k8s-ci-robot merged commit 26bb7b5 into kubernetes-sigs:main Feb 12, 2024
21 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.7 milestone Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/release Issues or PRs related to releasing 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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.

Improve Generate weekly PR updates to post in Slack docs/process
5 participants