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

Mention that GITHUB_* and RUNNER_* can't be set using GITHUB_ENV (but that CI can be) #20069

Closed
wants to merge 4 commits into from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Aug 23, 2022

Why:

Closes #19626

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

Adding note about default vars immutability.

https://docs-20069-a70e64.preview.ghdocs.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
image

https://docs-20069-a70e64.preview.ghdocs.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable

image

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column 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")

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

github-actions bot commented Aug 23, 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
actions/learn-github-actions/environment-variables.md fpt
ghec
ghes@ 3.9 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.9 3.8 3.7 3.6 3.5 3.4
ghae
actions/using-workflows/workflow-commands-for-github-actions.md fpt
ghec
ghes@ 3.9 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.9 3.8 3.7 3.6 3.5 3.4
ghae

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

@jsoref jsoref changed the title Mention that GITHUB_* and RUNNER_* can't be set using `GITHUB_ENV… Mention that GITHUB_* and RUNNER_* can't be set using GITHUB_ENV (but that CI can be) Aug 23, 2022
@cmwilson21
Copy link
Contributor

👋 @jsoref Thanks so much for opening a PR! I'll get this triaged for review ⚡

@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 Aug 23, 2022
@martin389 martin389 added the needs SME This proposal needs review from a subject matter expert label Sep 13, 2022
@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Oct 13, 2022
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Oct 14, 2022
@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Nov 11, 2022
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Nov 14, 2022
@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Dec 12, 2022
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Dec 12, 2022
@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Jan 10, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Jan 11, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 8, 2023

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Feb 8, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Feb 9, 2023
@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Mar 10, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Mar 13, 2023
@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Apr 10, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Jun 12, 2023
hubwriter
hubwriter previously approved these changes Jun 20, 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.

@jsoref - Many thanks for raising this PR. Apologies it has taken a long time to review and merge it.

I've reworded the reusable a little and added links outside of the reusable.

I'll go ahead and apply those changes so that we can get this merged now.

Thanks again for your help. 🙇

@hubwriter
Copy link
Contributor

Unfortunately, due to us taking so long to review this, there are now conflicts in these files which need resolved before we can merge this:

  • content/actions/learn-github-actions/environment-variables.md
  • content/actions/using-workflows/workflow-commands-for-github-actions.md

@jsoref
Copy link
Contributor Author

jsoref commented Jun 20, 2023

@hubwriter: can you deal w/ them? I'm unlikely to know the context of those changes.

If things are simple enough, I can do a rebase and reapply the spirit of the current head of this branch...

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.

@jsoref - There are a couple of simple changes need to avoid the conflicts in this PR.

  • One of the files was renamed, but the same change can be made in the renamed file.
  • A subheading has been changed in the current version of the docs.

I've marked these inline on the diff.

@@ -124,6 +124,8 @@ Any new environment variables you set that point to a location on the filesystem

The default environment variables that {% data variables.product.prodname_dotcom %} sets are available to every step in a workflow.

{% data reusables.actions.environment-variables-are-fixed %} For more information about setting environment variables, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-environment-variables-for-a-single-workflow)" and "[AUTOTITLE](/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable)."
Copy link
Contributor

Choose a reason for hiding this comment

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

The environment-variables.md file is now called variables.md. After merging main from upstream into your issue-19626 branch you can make the above insertion into the same place in the variables.md file and delete environment-variables.md.

@@ -580,6 +580,8 @@ echo "{environment_variable_name}={value}" >> $GITHUB_ENV

You can make an environment variable available to any subsequent steps in a workflow job by defining or updating the environment variable and writing this to the `GITHUB_ENV` environment file. The step that creates or updates the environment variable does not have access to the new value, but all subsequent steps in a job will have access. The names of environment variables are case-sensitive, and you can include punctuation. For more information, see "[Environment variables](/actions/learn-github-actions/environment-variables)."

{% data reusables.actions.environment-variables-are-fixed %} For more information about the default environment variables, see "[AUTOTITLE](/actions/learn-github-actions/environment-variables#default-environment-variables)."

### Example
Copy link
Contributor

Choose a reason for hiding this comment

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

The current text of this subheading is:

Suggested change
### Example
### Example of writing an environment variable to `GITHUB_ENV`

Changing this will avoid a conflict.

@hubwriter
Copy link
Contributor

@jsoref - I don't have write access to your fork of the docs repo, so I can't fix up the conflicts. I'll close this PR and make the same changes on a new PR.

@hubwriter hubwriter closed this Jul 17, 2023
@hubwriter
Copy link
Contributor

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 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.

Mention that GITHUB_* and RUNNER_* can't be set using GITHUB_ENV (but that CI can be)
4 participants