Skip to content

Update and improve PowerShell code#24884

Merged
jc-clark merged 4 commits into
github:mainfrom
bjompen:workflowcommandsforgithubactions
Aug 15, 2023
Merged

Update and improve PowerShell code#24884
jc-clark merged 4 commits into
github:mainfrom
bjompen:workflowcommandsforgithubactions

Conversation

@bjompen

@bjompen bjompen commented Apr 5, 2023 •
edited by cmwilson21
Loading

Copy link
Copy Markdown
Contributor

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

@welcome

welcome Bot commented Apr 5, 2023

Copy link
Copy Markdown

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 Apr 5, 2023
@github-actions

github-actions Bot commented Apr 5, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

@cmwilson21

cmwilson21 commented Apr 5, 2023

Copy link
Copy Markdown
Contributor

@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! ⚡

@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 Apr 5, 2023
@cmwilson21 cmwilson21 added the needs SME This proposal needs review from a subject matter expert label Aug 9, 2023
@github-actions

github-actions Bot commented Aug 9, 2023

Copy link
Copy Markdown
Contributor

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

jc-clark
jc-clark approved these changes Aug 10, 2023
View reviewed changes

@jc-clark jc-clark left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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!

@bjompen

bjompen commented Aug 11, 2023

Copy link
Copy Markdown
Contributor Author

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

@jc-clark jc-clark enabled auto-merge August 15, 2023 16:42
@jc-clark jc-clark added this pull request to the merge queue Aug 15, 2023
Merged via the queue into github:main with commit 6cf895d Aug 15, 2023
@github-actions

github-actions Bot commented Aug 15, 2023

Copy link
Copy Markdown
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 ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jc-clark jc-clark jc-clark approved these changes

Assignees

No one assigned

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

PowerShell examples does not follow best practices

3 participants

@bjompen @cmwilson21 @jc-clark