-
Notifications
You must be signed in to change notification settings - Fork 60.3k
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
update name of secret #12095
Conversation
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.
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. |
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 changesYou 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.
|
@lpmi-13 |
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.
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 👍🏻
content/actions/learn-github-actions/workflow-syntax-for-github-actions.md
Outdated
Show resolved
Hide resolved
@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. |
@lpmi-13 - I'm glad that I checked with the Actions docs team 😌 It turns out that this example uses the special I'm glad that you raised this PR to highlight the confusion here 🙇🏻♀️ |
A different error message would be very helpful. Thanks for the quick response on this 👍 |
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:
Writer impact (This section is for GitHub staff members only):