-
Notifications
You must be signed in to change notification settings - Fork 59.5k
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
Clarify access level needed for secrets in web interface #2330
Conversation
Closes github#1087 I considered changing the `permissions-statement-secrets-repository` reusable to include a reference to the API, but then I noticed that the other place using it (["Enabling debug logging"][1]) already mentioned the API, so instead I added a note. Including a mention of "web interface" lead to (IMO) too much duplication in text, so I rephrased it to be more like the `permissions-statement-secrets-api` reusable. [1]: https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/enabling-debug-logging
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Thanks so much for opening a PR @muru! I'll get this triaged for the team to take a look when they're back from the holidays 💖 |
This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit. |
Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨ |
This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit. |
This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit. |
Is the closure intentional? Should I amend the PR? |
I'm so sorry about that @muru! No amendments needed. It looks like our new action inadvertently closed this 🙃 Reopening and triaging this for review 💛 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@muru - Many thanks for raising this PR.
I like the note that you added, with the link to the secrets API page, that's useful, thanks.
I think we should stick with the current reusable text. IMO it makes a clearer distinction between what you need to create a secret for a user account repo and what you need to create a secret for an organization repo.
data/reusables/github-actions/permissions-statement-secrets-repository.md
Outdated
Show resolved
Hide resolved
…pository.md I'm going to go ahead and change this back.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@muru - As this PR has been waiting for our attention for so long I'm going to go ahead and merge the modified version (without the change to the reusable text).
Many thanks again for taking the time to help improve our docs. It's much appreciated. 👍
Of course if you disagree with my comments please get back in touch.
All the best.
@hubwriter that's fine by me! Thanks for reviewing! |
Why:
Closes #1087
What's being changed:
I changed the initial text of "Creating encrypted secrets for a repository" and also added a note at the end of that section:
Including a mention of "web interface" lead to (IMO) too much duplication in text, so I rephrased it to be more like the
permissions-statement-secrets-api
reusable.I considered changing the
permissions-statement-secrets-repository
reusable to include a reference to the API, but then I noticed that the other place using it ("Enabling debug logging") already mentioned the API, so instead I added a note.Screenshot of "Creating encrypted secrets for a repository", with the unchanged parts snipped:
Screenshot of "Enabling debug logging":
Check off the following: