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 GitHub PAT doc #7240

Merged

Conversation

aniruddha2000
Copy link
Contributor

Signed-off-by: Aniruddha Basak [email protected]

What this PR does / why we need it:
It's a doc PR that adds information about GitHub Personal Access Token to avoid rate limiting.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #7188

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 19, 2022
@aniruddha2000
Copy link
Contributor Author

/cc @ykakarap @fabriziopandini

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 19, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @aniruddha2000. 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.

Copy link
Contributor

@oscr oscr left a comment

Choose a reason for hiding this comment

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

This section mentions scope and how to export the token. Maybe of value here?

1. If you don't have a GitHub token, create one by going to your GitHub settings, in [Personal access tokens](https://github.com/settings/tokens). Make sure you give the token the `repo` scope.
1. Wait for the above job to complete for the tag commit and for the image to exist in the staging repository, then create a PR to promote the image and tag:
- `export GITHUB_TOKEN=<your GH token>`

Overall great. Minor changes and I think this will be a great addition.

docs/book/src/clusterctl/overview.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/overview.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ykakarap ykakarap left a comment

Choose a reason for hiding this comment

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

Looms good overall. Just a couple of suggeestions.

Can you also please link this section in the clusterctl init page and the clusterctl configuration page as requested here

docs/book/src/clusterctl/overview.md Outdated Show resolved Hide resolved
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/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 Sep 20, 2022
@aniruddha2000 aniruddha2000 force-pushed the aniruddha/github-pat-doc branch from cf68f5f to 948dda3 Compare September 20, 2022 14:31
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 20, 2022
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

one small nits, otherwise lgtm

docs/book/src/clusterctl/overview.md Outdated Show resolved Hide resolved
Signed-off-by: Aniruddha Basak <[email protected]>
@aniruddha2000 aniruddha2000 force-pushed the aniruddha/github-pat-doc branch from 948dda3 to 82fb7b4 Compare September 21, 2022 14:50
@oscr
Copy link
Contributor

oscr commented Sep 21, 2022

A small advice for future prs: don't forget to resolve comments after you've completed them. Otherwise great work!

/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 21, 2022
@aniruddha2000
Copy link
Contributor Author

@oscr I will keep that in mind :)

@fabriziopandini
Copy link
Member

/lgtm
/approve

/cherry-pick release-1.2

@k8s-infra-cherrypick-robot

@fabriziopandini: once the present PR merges, I will cherry-pick it on top of release-1.2 in a new PR and assign it to you.

In response to this:

/lgtm
/approve

/cherry-pick release-1.2

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.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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 Sep 21, 2022
@k8s-ci-robot k8s-ci-robot merged commit 4f07520 into kubernetes-sigs:main Sep 21, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Sep 21, 2022
@k8s-infra-cherrypick-robot

@fabriziopandini: new pull request created: #7265

In response to this:

/lgtm
/approve

/cherry-pick release-1.2

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.

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. 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the github Personal Access Token requirement in the book
7 participants