Skip to content

Update example to use env. within expression #26654

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

Merged
merged 12 commits into from
Sep 14, 2023
Merged

Conversation

kaylareopelle
Copy link
Contributor

Why:

The example as-is did not work for me on ubuntu-latest. This syntax worked. I received an "Invalid workflow file" error. See issue #26653 for details.

Closes: #26653

What's being changed (if available, include any code snippets, screenshots, or gifs):

Changing the example from using $ENVIRONMENT_VARIABLE to env.ENVIRONMENT_VARIABLE.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

The example as-is did not work for me on ubuntu-latest. This syntax worked. I received an "Invalid workflow file" error.
@welcome
Copy link

welcome bot commented Jul 12, 2023

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 Jul 12, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 12, 2023

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
actions/learn-github-actions/variables.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

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

Nat253

This comment was marked as spam.

@cmwilson21
Copy link
Contributor

@kaylareopelle Thank you for opening a PR and linking it to your issue! And welcome to the community! ✨

And thanks for the extra context in the details in the issue. I'll get this triaged for review ⚡

In the meantime, if you'd like to find other ways to contribute, check out our help wanted section to find open issues you can work on. 👍

@cmwilson21 cmwilson21 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 and removed triage Do not begin working on this issue until triaged by the team labels Jul 13, 2023
Copy link
Contributor

@hubwriter hubwriter left a comment

Choose a reason for hiding this comment

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

@kaylareopelle - Many thanks for submitting this PR. Seems like the current docs here need some rework, but I don't think we should change this section to use the env context. See my comment on the issue, and my suggestions on this PR.

If you're okay with my suggested changes we can get this merged/published.

Thanks again for taking the time to raise the issue and this PR. 🙇

@kaylareopelle
Copy link
Contributor Author

Hi @hubwriter thanks for the suggested changes. I'm away on vacation this week and would prefer to pick this up again when I'm back. Could we reconvene next week?

@hubwriter
Copy link
Contributor

Note to self 😄
See the conversation on the issue #26653.

@hubwriter
Copy link
Contributor

@kaylareopelle - Hi 👋
Let me know what you think about the changes I've suggested to this PR. It would be good to get this merged.
Thanks again 👍

@kaylareopelle
Copy link
Contributor Author

Hi @hubwriter, thanks for the reminder about this. I've committed your suggestions. I have a few other changes I'd like to propose as part of this PR and will commit them soon.

@kaylareopelle
Copy link
Contributor Author

Ok, @hubwriter! I've added my changes. I'm also open to feedback on my commit messages and the number of commits. I looked for documentation about how GitHub docs prefer to have commits written, but couldn't find an answer.

@hubwriter
Copy link
Contributor

@kaylareopelle - Thank you for doing more work on this. However, your changes seem to say that run: statements are exclusively the things that get sent to the runner. Unfortunately I'm pretty sure things aren't that simple - i.e. I don't think we can say words to the effect of: the stuff under run: is sent to the runner, so use runner environment variables ($VARIABLE) there, and everything else gets processed by GitHub Actions and isn't seen by the runner, so use the env context in those parts of the workflow (${{ env.VARIABLE }}).

I've asked for some expert eyes on this, so that we can make sure the wording is accurate. Clearly this isn't explained well enough in the docs right now so it would be good to improve this article.

I'll return to this once I've had advice from an SME.
Thanks again.

@hubwriter hubwriter added blocked This issue or PR is currently blocked needs SME This proposal needs review from a subject matter expert labels Aug 25, 2023
@github-actions
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@kaylareopelle
Copy link
Contributor Author

Thanks, @hubwriter! I appreciate you sticking with me on this.

Copy link
Contributor

@hubwriter hubwriter left a comment

Choose a reason for hiding this comment

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

@kaylareopelle - After getting some advice on this from the development team, I've suggested a few further changes. These are just a slight adjustment in emphasis to your previous changes.

Thank you for your patience. If you are happy with these suggestions, please just click "Commit suggestion" for them and I'll get this PR merged.

@hubwriter
Copy link
Contributor

@kaylareopelle - just bumping my previous message: #26654 (review)

If I don't hear from you to the contrary I'll apply those suggested changes so that we can get this merged.

@kaylareopelle
Copy link
Contributor Author

kaylareopelle commented Sep 13, 2023

Hi @hubwriter, thanks for your patience and for these updates. I think everything seems much clearer, though I'm not quite sure what the phrase "referenced actions" means in two of the updates. Can you clarify?

hubwriter
hubwriter previously approved these changes Sep 14, 2023
hubwriter
hubwriter previously approved these changes Sep 14, 2023
@hubwriter hubwriter enabled auto-merge September 14, 2023 09:34
@hubwriter hubwriter disabled auto-merge September 14, 2023 09:36
@hubwriter hubwriter enabled auto-merge September 14, 2023 10:00
@hubwriter hubwriter added this pull request to the merge queue Sep 14, 2023
Merged via the queue into github:main with commit 8d2941f Sep 14, 2023
@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

@kaylareopelle kaylareopelle deleted the patch-1 branch October 6, 2023 22:28
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 blocked This issue or PR is currently blocked content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert 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.

Variables environment variable example is misleading
5 participants