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

Fixed PowerShell Copilot alias creation script #32188

Closed
wants to merge 1 commit into from

Conversation

mpusch88
Copy link

@mpusch88 mpusch88 commented Mar 23, 2024

Why:

The previous version of the GitHub Copilot alias setup guide for PowerShell was creating a new line in the PowerShell profile after each run.

Closes:

#32187

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

Old:

echo ". $GH_COPILOT_PROFILE" >> $PROFILE

New:

. $GH_COPILOT_PROFILE

As this line is already in the profile, this will have the same effect. I am convinced this was written by AI and not checked.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

  • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.

  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Mar 23, 2024

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 Mar 23, 2024
Copy link
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
copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli.md fpt
ghec
fpt
ghec

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 linked an issue Mar 25, 2024 that may be closed by this pull request
1 task
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review copilot Content related to GitHub Copilot content This issue or pull request belongs to the Docs Content team and removed triage Do not begin working on this issue until triaged by the team labels Mar 25, 2024
@nguyenalex836
Copy link
Contributor

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

@mklement0
Copy link

Unfortunately, this is the wrong fix: you don't want to recreate aliases every time the profile is loaded.

All that is needed is to fix the instructions, for all shells, as argued here; in short: make it clear that the code is one-time setup code that programmatically updates the profiles / initialization files - no need to add anything to the latter manually.

@nguyenalex836
Copy link
Contributor

All that is needed is to fix the instructions, for all shells

@mklement0 Thank you for the input on this! After our team reviews and validates whether this is the case, you or anyone else would be welcome to submit a PR to make that correction 💛

@mpusch88 mpusch88 closed this 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 this pull request may close these issues.

Fix GitHub Copilot CLI Powershell Alias instructions
3 participants