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

update name of secret #12095

Closed
wants to merge 3 commits into from
Closed

update name of secret #12095

wants to merge 3 commits into from

Conversation

lpmi-13
Copy link

@lpmi-13 lpmi-13 commented Nov 17, 2021

When attempting to follow the guide and set a value for a secret called GITHUB_SECRET, the UI presented the following error:

"Failed to add secret. Secret names must not start with GITHUB_."

If this is not a valid naming convention for secrets, then we shouldn't use it in the documentation.

Why:

Closes #12094

What's being changed:

The name of the secret in the example.

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.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

When attempting to follow the guide and set a value for a secret called `GITHUB_SECRET`, the UI presented the following error:

"Failed to add secret. Secret names must not start with GITHUB_."

If this is not a valid naming convention for secrets, then we shouldn't use it in the documentation.
@welcome
Copy link

welcome bot commented Nov 17, 2021

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 17, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Nov 17, 2021

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 Staging Production What Changed
content/actions/learn-github-actions/workflow-syntax-for-github-actions.md Modified Original

@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 18, 2021
@ramyaparimi
Copy link
Contributor

@lpmi-13
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

Hi @lpmi-13 👋🏻

Thank you so much for this update to the docs. You're right - this is a bad example. I'm not sure how it slipped through the review process 🙈

I'm going to make one change, but otherwise this looks good to merge 👍🏻

@felicitymay felicitymay added the ready to merge This pull request is ready to merge label Nov 19, 2021
@github-actions github-actions bot removed the waiting for review Issue/PR is waiting for a writer's review label Nov 19, 2021
@felicitymay felicitymay removed the ready to merge This pull request is ready to merge label Nov 19, 2021
@felicitymay
Copy link
Contributor

@lpmi-13 - I did a quick check of the rest of the docs and found some other places where we used the same example. 🤔

I'm checking internally that your change is correct before merging the change - just in case I've missed something important. It's possible that there are other places we should make the same fix.

@felicitymay
Copy link
Contributor

@lpmi-13 - I'm glad that I checked with the Actions docs team 😌

It turns out that this example uses the special GITHUB_TOKEN that is created automatically for each workflow run. This is explained here: Automatic token authentication.

I'm glad that you raised this PR to highlight the confusion here 🙇🏻‍♀️
I'm going to report this to the team who maintain this area of the product and suggest that provide a tailored error message if someone tries to create a secret called GITHUB_TOKEN.

@lpmi-13
Copy link
Author

lpmi-13 commented Nov 19, 2021

A different error message would be very helpful. Thanks for the quick response on this 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The documentation suggests an invalid value for the name of a secret
3 participants