Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix GitHub Copilot CLI Powershell Alias instructions #32187

Open
1 task done
mpusch88 opened this issue Mar 23, 2024 · 5 comments
Open
1 task done

Fix GitHub Copilot CLI Powershell Alias instructions #32187

mpusch88 opened this issue Mar 23, 2024 · 5 comments
Labels
content This issue or pull request belongs to the Docs Content team copilot Content related to GitHub Copilot waiting for review Issue/PR is waiting for a writer's review

Comments

@mpusch88
Copy link

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 mpusch88 added the content This issue or pull request belongs to the Docs Content team label Mar 23, 2024
Copy link

welcome bot commented Mar 23, 2024

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 23, 2024
@mklement0
Copy link

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.

@nguyenalex836 nguyenalex836 added copilot Content related to GitHub Copilot and removed triage Do not begin working on this issue until triaged by the team labels Mar 25, 2024
@nguyenalex836 nguyenalex836 linked a pull request Mar 25, 2024 that will close this issue
3 tasks
@nguyenalex836
Copy link
Contributor

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

@mpusch88
Copy link
Author

mpusch88 commented Mar 27, 2024

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.

@nguyenalex836
Copy link
Contributor

@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 nguyenalex836 added the waiting for review Issue/PR is waiting for a writer's review label Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team copilot Content related to GitHub Copilot waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@mklement0 @mpusch88 @nguyenalex836 and others