Skip to content

Conversation

@jessehouwing
Copy link
Contributor

@jessehouwing jessehouwing commented Feb 11, 2022

Closes: #15355

Why:

The default shell on Windows ir now pwsh, all of the examples are only for bash. And there are a few caveats.

Ideally the page would be rplit across technology [bash, pwsh, powershell, javascript] and not [linux, mac, windows] cause, like bash, pwsh is also available on all platforms. I couldn't find how to easily make a tech selector for things other than targetPlatform.

What's being changed:

This adds a pwsh example to each place where action command examples are shown in bash.

Staging preview:

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Work in progress

  • Add some kind of platform / tool selector
  • Verify examples for any caveats that may be missing
  • Verify the New-Guid approach is valid alternative over getting the sha256 hash of the github token.
  • Does there need to be a link to the default shell per platform in here anywhere?

@welcome
Copy link

welcome bot commented Feb 11, 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.

@jessehouwing jessehouwing temporarily deployed to preview-env-15354 February 11, 2022 16:11 Inactive
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 11, 2022
@jessehouwing jessehouwing temporarily deployed to preview-env-15354 February 11, 2022 16:28 Inactive
@ramyaparimi ramyaparimi 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 and removed triage Do not begin working on this issue until triaged by the team labels Feb 11, 2022
@ramyaparimi
Copy link
Contributor

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

@ramyaparimi ramyaparimi added actions This issue or pull request should be reviewed by the docs actions team GH devops MVP labels Feb 11, 2022
Copy link

@fullofhope336 fullofhope336 left a comment

Choose a reason for hiding this comment

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

``

@martin389 martin389 self-requested a review February 14, 2022 00:02
@martin389 martin389 temporarily deployed to preview-env-15354 February 14, 2022 02:32 Inactive
@martin389 martin389 temporarily deployed to preview-env-15354 February 14, 2022 02:39 Inactive
@martin389 martin389 temporarily deployed to preview-env-15354 February 14, 2022 05:18 Inactive
@martin389 martin389 temporarily deployed to preview-env-15354 February 14, 2022 05:56 Inactive
@jessehouwing
Copy link
Contributor Author

Some issues with this way of displaying:

For YAML blocks setting the highlighting to powershell the wrong keywords are highlighted.
image

And it's unclear that this is PowerShel Core 6+ (pwsh) instead of Windows PowerShell 5 and below.

In the legacy example the difference is even more important.
image

@jessehouwing jessehouwing temporarily deployed to preview-env-15354 February 14, 2022 16:06 Inactive
@martin389
Copy link
Contributor

martin389 commented Feb 14, 2022

@jessehouwing -- Thanks for the feedback!

For YAML blocks setting the highlighting to powershell the wrong keywords are highlighted.

We don't currently have a way to correctly render multiple languages within the same codeblock 🤔 We're finding that the codeblock titles for "Shell" and "PowerShell" are useful for letting us distinguish them, and saves us from having to keep each example in a separate subsection -- this would occupy a lot more screen space and make it difficult for users to scan through the content.

And it's unclear that this is PowerShel Core 6+ (pwsh) instead of Windows PowerShell 5 and below.

I've added intro text for each of these examples, to make it clearer which version is being referenced. Unfortunately our docs site doesn't let us easily add new languages.

@martin389 martin389 temporarily deployed to preview-env-15354 February 15, 2022 01:57 Inactive
@martin389 martin389 temporarily deployed to preview-env-15354 February 15, 2022 02:03 Inactive
@martin389 martin389 closed this Mar 7, 2022
@martin389 martin389 reopened this Mar 7, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 7, 2022
@ramyaparimi ramyaparimi removed the triage Do not begin working on this issue until triaged by the team label Mar 7, 2022
@martin389
Copy link
Contributor

Status update: docs engineering are investigating the staging issue

@jessehouwing
Copy link
Contributor Author

For some reason this header doesn't render as it's supposed to on the preview environment:

## Echoing command outputs

image

@martin389
Copy link
Contributor

For some reason this header doesn't render as it's supposed to on the preview environment:

## Echoing command outputs

Looks like your commit fixed it 😄 🎊

@martin389
Copy link
Contributor

Following up on the content plan consideration described here: #15354 (comment)

@martin389
Copy link
Contributor

@martin389 We have an issue that @skedwards88 recently opened to define guidelines for using the tool picker that we should address before adding more tools to it, so that we have a shared understanding for when it's appropriate for the platform overall to include a tool.

Thanks @emilyistoofunky, I've added the reasoning for the two new tools to @skedwards88's issue 👍

skedwards88
skedwards88 previously approved these changes Mar 17, 2022
@martin389
Copy link
Contributor

This is looking ready to ship 🚢 🎊 Just doing some final checks.

@martin389 martin389 merged commit d8ef545 into github:main Mar 21, 2022
@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

@martin389
Copy link
Contributor

@jessehouwing - Thanks again for this great PR, PowerShell users are definitely going to appreciate this update ✨

@martin389
Copy link
Contributor

Changes are now live: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions

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.

The Action workflow commands section assumes bash, but pwsh is now the default shell on windows

9 participants