Skip to content

Conversation

@thispsj
Copy link
Contributor

@thispsj thispsj commented May 24, 2022

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:

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

@github-actions
Copy link
Contributor

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 github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 24, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 24, 2022

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

@thispsj thispsj marked this pull request as ready for review May 25, 2022 14:32
@janiceilene
Copy link
Contributor

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

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review dependabot Content related to Dependabot and removed triage Do not begin working on this issue until triaged by the team labels May 27, 2022
@mchammer01 mchammer01 self-requested a review May 30, 2022 14:48
@mchammer01
Copy link
Contributor

mchammer01 commented May 30, 2022

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 ✨

Copy link
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

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

@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 %}**.
   ![{% data variables.product.prodname_dependabot %} secrets sidebar option](/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!

@Philepe25

This comment was marked as resolved.

@mchammer01
Copy link
Contributor

{% 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?

@thispsj
Copy link
Contributor Author

thispsj commented May 31, 2022

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

@mchammer01 mchammer01 removed the waiting for review Issue/PR is waiting for a writer's review label May 31, 2022
@mchammer01
Copy link
Contributor

@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 🙂

@thispsj
Copy link
Contributor Author

thispsj commented May 31, 2022

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 ?

@mchammer01
Copy link
Contributor

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

@thispsj
Copy link
Contributor Author

thispsj commented May 31, 2022

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

@thispsj
Copy link
Contributor Author

thispsj commented Jun 6, 2022

@cmwilson21 👋
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 thispsj requested a review from mchammer01 June 6, 2022 06:01
@mchammer01 mchammer01 removed their request for review June 13, 2022 13:59
@mchammer01 mchammer01 added the waiting for review Issue/PR is waiting for a writer's review label Jun 13, 2022
Copy link

@Vana12330 Vana12330 left a comment

Choose a reason for hiding this comment

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

0x8463a980e5b1fe116df96f8672dae9934b131cb5

thispsj and others added 2 commits September 20, 2022 13:39
Resolved conflicts in secret reusable data/reusables/actions/sidebar-secret.md
Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

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

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

@lucascosti lucascosti enabled auto-merge (squash) September 30, 2022 03:43
@lucascosti lucascosti merged commit 8783f59 into github:main Sep 30, 2022
@thispsj thispsj deleted the enc-secrets-steps-update branch September 30, 2022 03:51
@github-actions
Copy link
Contributor

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

@thispsj
Copy link
Contributor Author

thispsj commented Sep 30, 2022

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

@lucascosti no problem 🙂

@github github deleted a comment from lohva Sep 30, 2022
@github github deleted a comment from lohva Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team dependabot Content related to Dependabot waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

"Creating encrypted secrets for a repository" in "Encrypted Secrets" page is outdated

6 participants