docs icon indicating copy to clipboard operation
docs copied to clipboard

Fix GitHub Copilot CLI Powershell Alias instructions

Open mpusch88 opened this issue 1 year ago • 5 comments
trafficstars

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli

What part(s) of the article would you like to see updated?

What needs to be fixed:

The alias creation section for PowerShell.

Why:

The instructions provided add a new line to the PowerShell profile every time PowerShell is opened.

Expected Results:

Instructions should be updated to avoid adding a new line to the PowerShell profile every time PowerShell is opened.

Additional information

No response

mpusch88 avatar Mar 23 '24 00:03 mpusch88

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Mar 23 '24 00:03 welcome[bot]

To add some context:

The code shown in the linked instruction is setup code, meant to be run once in order to programmatically add the aliases (which are actually functions) to the profile / initialization files of supported shells, whereas the instructions, e.g. "Add the following to your PowerShell profile:", mistakenly suggest that this setup code itself should be added to the profile / initialization file.

mklement0 avatar Mar 23 '24 19:03 mklement0

@mpusch88 Thank you for opening this issue! I've linked the related PR ✨

nguyenalex836 avatar Mar 25 '24 13:03 nguyenalex836

I closed the PR as the fix was not correct.

I'd be happy to update the instructions, but need someone to fix the functions generated by the alias command for Windows PowerShell first.

mpusch88 avatar Mar 27 '24 22:03 mpusch88

@mpusch88

but need someone to fix the functions generated by the alias command for Windows PowerShell first.

I'll get this triaged for the team to review ✨

nguyenalex836 avatar Mar 27 '24 23:03 nguyenalex836

I noticed that this has been fixed now. The commands are now provided as commands to be run, rather than lines to add to a configuration file.

https://docs.github.com/en/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli

isaacmbrown avatar Jun 21 '24 08:06 isaacmbrown