Skip to content

Add additional shell script examples for the new Job output environment variables#22276

Closed
SimonDarksideJ wants to merge 4 commits into
github:mainfrom
SimonDarksideJ:feature/powershell_outputs
Closed

Add additional shell script examples for the new Job output environment variables#22276
SimonDarksideJ wants to merge 4 commits into
github:mainfrom
SimonDarksideJ:feature/powershell_outputs

Conversation

@SimonDarksideJ
Copy link
Copy Markdown

Why:

The documentation about the new Output variables for sharing data between jobs was inaccurate as it only handled the default Ubuntu "Bash" version of the commands.

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

This updates Job output variables to denote the different versions used for each shell language, kept original Bash, added Powershell and Python

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.

@welcome
Copy link
Copy Markdown

welcome Bot commented Nov 24, 2022

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 24, 2022
@cmwilson21
Copy link
Copy Markdown
Contributor

@SimonDarksideJ 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 waiting for review Issue/PR is waiting for a writer's review actions This issue or pull request should be reviewed by the docs actions team and removed triage Do not begin working on this issue until triaged by the team labels Nov 25, 2022
@SimonDarksideJ
Copy link
Copy Markdown
Author

All in the day as an MVP :S

@mrt-erl

This comment was marked as spam.

Copy link
Copy Markdown
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

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

👋 @SimonDarksideJ, thanks a lot for this PR!

🤔 This one's a bit of a tough situation. The use-case for the reusable that you've edited is to show the use of the YAML syntax for the jobs.<job_id>.outputs key, and not really for the scripting to set the environment variable that the key uses (we currently have that documented in "Workflow commands for GitHub Actions ."). We currently have the Bash and powershell examples there.

I do realize that we don't explain this at all for this jobs.<job_id>.outputs example 😅 . Instead of repeating the examples with different scripting, how about we add a short explanation of setting the environment variable and link to the relevant section of the workflow commands article instead?

@CERVANTESJERARDO48

This comment was marked as spam.

@nguyenalex836
Copy link
Copy Markdown
Contributor

@SimonDarksideJ I'll be closing this PR due to inactivity - but if you would like to work on this further, we're happy to reopen this PR 💛

@SimonDarksideJ
Copy link
Copy Markdown
Author

To be honest @nguyenalex836 I had given up on this PR as it did not seem desired, even though it was to address an issue I came across in the docs.

@nguyenalex836
Copy link
Copy Markdown
Contributor

I'm sorry to hear that, @SimonDarksideJ! Let us know if you'd like to reopen this PR - we're happy to do so 💛

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

6 participants