docs icon indicating copy to clipboard operation
docs copied to clipboard

Update steps to create repo secrets

Open thispsj opened this issue 2 years ago • 12 comments

Why:

Closes #17791

What's being changed:

Everything mentioned by @github-actions in Content Changes table. In Dependabot article, removed one step which was not needed.

233604b - Updated the reusable to the latest steps

Check off the following:

  • [x] I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • [X] For content changes, I have completed the self-review checklist.

thispsj avatar May 24 '22 12:05 thispsj

Thanks for submitting a PR to the GitHub Docs project!

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

github-actions[bot] avatar May 24 '22 12:05 github-actions[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3
codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces.md fpt
ghec
fpt
ghec

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar May 24 '22 12:05 github-actions[bot]

@thispsj Thanks so much for opening a PR! I'll get this triaged for review ✨

janiceilene avatar May 27 '22 14:05 janiceilene

I'll review this and need to check the behavior on GHES 3.3, 3.4 and 3.5. The updates look fine for GitHub.com and GHEC ✨

mchammer01 avatar May 30 '22 15:05 mchammer01

Ok

On Tue, May 31, 2022, 2:02 AM mc @.***> wrote:

@.**** commented on this pull request.

@thispsj https://github.com/thispsj 👋🏻 - thanks for your contribution ✨

I've made some suggestions as I tested the behavior on dotcom, GHES 3.3, GHES 3.4 and GHES 3.5. I'd like to edit the {% data reusables.actions.sidebar-secret %} reusable (found in data/reusables/dependabot/dependabot-secrets-button) but I wasn't able to fetch your branch and add a commit. I'd like to edit it so it contains the following:

{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5658 %}

  1. Inside the "Secrets" section of the sidebar, click {% data variables.product.prodname_dependabot %}. [image: {% data variables.product.prodname_dependabot %} secrets sidebar option] http:///assets/images/enterprise/3.3/dependabot/dependabot-secrets.png {% endif %}

Can you help with that? (Not sure why I can't get your branch). Thanks!

In content/code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot.md https://github.com/github/docs/pull/18175#discussion_r885256682:

@@ -49,7 +49,6 @@ The name of a {% data variables.product.prodname_dependabot %} secret:

{% data reusables.repositories.navigate-to-repo %}

{% data reusables.repositories.sidebar-settings %}

⬇️ Suggested change

-{% data reusables.repositories.sidebar-settings %}

+{% data reusables.repositories.sidebar-settings %}

+{% data reusables.actions.sidebar-secret %}


In data/reusables/actions/sidebar-secret.md https://github.com/github/docs/pull/18175#discussion_r885261219:

@@ -1,5 +1,5 @@

{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}

-1. In the left sidebar, click {% octicon "key-asterisk" aria-label="The key-asterisk icon" %} Secrets.

+1. In the "Security" section of the sidebar, select {% octicon "key-asterisk" aria-label="The key-asterisk icon" %} Secrets, then click Actions.

Reverting as this just documents us getting to the Secrets option. Also, this reusable is used in 4 different other files so this update would impact these files too. ⬇️ Suggested change

-1. In the "Security" section of the sidebar, select {% octicon "key-asterisk" aria-label="The key-asterisk icon" %} Secrets, then click Actions.

+In the left sidebar, click {% octicon "key-asterisk" aria-label="The key-asterisk icon" %} Secrets.

— Reply to this email directly, view it on GitHub https://github.com/github/docs/pull/18175#pullrequestreview-989911485, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASJB3XNC22GHGMFNP757FNDVMW2RVANCNFSM5WZMA3CA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Philepe25 avatar May 31 '22 07:05 Philepe25

{% data reusables.actions.sidebar-secret %} is used in 4 files:

  1. content/actions/security-guides/encrypted-secrets.md (3 occurrences)
  2. content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md (1 occurrence)
  3. content/code-security/dependabot/working-with-dependabot\managing-encrypted-secrets-for-dependabot.md (2 occurrences)
  4. /content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md (1 occurence)

1 and 2 relate to Actions, 3 to Dependabot and 4 to Codespaces.

@thispsj 👋🏻 - so my recommendation would be to:

A- Update {% data reusables.actions.sidebar-secret %} so that it mentions clicking "Actions" inside "Secrets" (like you initially did in this PR). This takes care of 1 and 2. We can no longer use this reusable for 3 and 4 as it now specifically mentions Actions.

B. Add 2 new reusables, one in data/reusables/dependabot called sidebar-secret (so you'd use {% data reusables.dependabot.sidebar-secret %} when calling the reusable) and the other in data/reusables/codespaces (so you'd use {% data reusables.codespaces.sidebar-secret %} when calling the reusable), which should be used in the files involved in 3 and 4. In one, we instruct the user to select "Secrets" on the left sidebar, then click "Dependabot" inside the "Secrets" section, whereas for the the other one, we tell them to select "Secrets" on the left sidebar, then click "Codespaces" inside the "Secrets" section.

What do you think? Do you feel comfortable with implementing this?

mchammer01 avatar May 31 '22 10:05 mchammer01

@mchammer01 ya absolutely comfortable. I'll implement this.

thispsj avatar May 31 '22 12:05 thispsj

@thispsj 👋🏻 - I'm going to be away for a few days so once your new updates are ready, would you mind re-adding the waiting for review label to this PR, so that it gets added to our review board? Thank you 🙂

mchammer01 avatar May 31 '22 15:05 mchammer01

Hi @mchammer01 , How can I re label waiting for review ? I don't have triage access to this repo (I wish I had).

What if I put these changes right now ?

thispsj avatar May 31 '22 15:05 thispsj

@janiceilene / @cmwilson21 - could you put this up for review once @thispsj has made the suggested changes? Thank youuu 🙇🏻 😄

mchammer01 avatar May 31 '22 16:05 mchammer01

@mchammer01 good idea, I'll just tag one of them once I'm done.

thispsj avatar May 31 '22 16:05 thispsj

@cmwilson21 :wave: This PR is ready for a review now ! Please add the waiting for review label so that it gets added to the review board.

thispsj avatar Jun 06 '22 06:06 thispsj

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Sep 30 '22 03:09 github-actions[bot]

Sorry for the delay on this one! I've resolved the conflicts and all looks good. I'll get this merged! 🚀

@lucascosti no problem 🙂

thispsj avatar Sep 30 '22 03:09 thispsj