-
Notifications
You must be signed in to change notification settings - Fork 65.2k
docs(actions): make helpful note about env variable visually apparent #4549
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
docs(actions): make helpful note about env variable visually apparent #4549
Conversation
|
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. |
|
@roadlittledawn Thanks so much for opening a PR! I'll get this triaged for review ⚡ |
|
@roadlittledawn Thanks for your contribution! This reusable is used in a few places (3 times in Events that trigger workflows and once in Encrypted secrets). Can you share which section felt like it needed a callout? I ask because in the "Events that trigger workflows" article, this will now result in 3 notes close together, so we may want to consider a different solution, like just wrapping the reusable in a note in the "Encrypted secrets" article if that was where you felt needed the additional highlight: |
|
@skedwards88 yeah i kind of wondered if the reusable content snippet should only be given the callout treatment in context of the article and not everywhere. the section we were reading that prompted to file PR was this one: https://docs.github.com/en/actions/reference/encrypted-secrets#using-encrypted-secrets-in-a-workflow |
|
Thanks for adding this context! I think adding the |
|
I've applied the changed agreed by @roadlittledawn above - i.e. put the text in a note box just in this article. |
|
@roadlittledawn - Many thanks for pointing this out and suggesting the change. Much appreciated. I'm going to merge this now. |
|
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 ⚡ |
|
thanks much! |

Why:
Scanning this page took us about 30min to find an important tidbit of info re:
GITHUB_TOKENbeing the only available secret available for a runner on a forked repo.What's being changed:
Changed a reusable snippet that contained an important tidbit about the GITHUB_TOKEN env var into a note callout. Wasn't sure if it should always be a called out, but we would certainly find that helpful. Otherwise, maybe the snippet should just be wrapped in a note?
Check off the following: