docs icon indicating copy to clipboard operation
docs copied to clipboard

Update and improve PowerShell code

Open bjompen opened this issue 1 year ago â€ĸ 3 comments

Why:

Closes #24883

This PR fixes code examples in workflow-commands-for-github-actions.md to better reflect PowerShell commonly agreed best practices by

  • Replacing aliases with full commands
  • Using named parameters instead of positional
  • Replace stream redirects with PowerShell commands

I did not put the closed tag on it as there may be more places where the PowerShell code could be improved.

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

>> -> Out-File rm -> Remove-Item set ENV -> $ENV =

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).
  • [x] For content changes, I have completed the self-review checklist.

bjompen avatar Apr 05 '23 09:04 bjompen

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.

welcome[bot] avatar Apr 05 '23 09:04 welcome[bot]

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/using-workflows/workflow-commands-for-github-actions.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

github-actions[bot] avatar Apr 05 '23 09:04 github-actions[bot]

@bjompen Thanks for opening an issue and submitting a PR! I've edited your post slightly so it links to issue 👍

I'll get this triaged for review! :zap:

cmwilson21 avatar Apr 05 '23 20:04 cmwilson21

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

github-actions[bot] avatar Aug 09 '23 14:08 github-actions[bot]

Thank you for making this update @bjompen. We really appreciate you helping keep the docs updated 🌟

I resolved the conflicts in your PR and updated the branch. Most of the changes I made involved changing the pwsh{:copy} to pwsh copy to conform with the rest of the code-block copy buttons.

Let me know what you think of that and I can help get this merged for you. Cheers!

Thanks for the help! no issues from me, LGTM :)

bjompen avatar Aug 11 '23 07:08 bjompen

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 :zap:

github-actions[bot] avatar Aug 15 '23 16:08 github-actions[bot]