8c62486a96
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Hector Alfaro <hectorsector@github.com> Co-authored-by: Vanessa <vgrl@github.com> Co-authored-by: Erin Havens <erinhav@github.com> Co-authored-by: Aaron Waggener <73763104+aaronwaggener@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> Co-authored-by: Sarah Schneider <sarahs@github.com>
214 lines
16 KiB
Markdown
214 lines
16 KiB
Markdown
---
|
|
title: Using Copilot to help you work on a pull request
|
|
shortTitle: Working on a PR
|
|
intro: 'You can iterate, validate, and integrate suggested changes to code by using {% data variables.product.prodname_copilot_workspace %}.'
|
|
product: '{% data reusables.gated-features.copilot-free-availability %}'
|
|
versions:
|
|
feature: copilot-hadron
|
|
topics:
|
|
- Copilot
|
|
---
|
|
|
|
> [!NOTE] {% data variables.product.prodname_copilot_workspace %} is currently in limited {% data variables.release-phases.public_preview %}. The waitlist for admission to this preview is currently closed.
|
|
|
|
## About using {% data variables.product.prodname_copilot_short %} to help you work on your pull requests
|
|
|
|
After you create a pull request, you can continue working on the PR on the {% data variables.product.github %} website. This article is about {% data variables.product.prodname_copilot_workspace %}, which provides a {% data variables.product.prodname_copilot_short %}-enabled environment for:
|
|
|
|
* **Refining** your pull requests
|
|
* **Validating** changes
|
|
* **Integrating** suggestions from reviewers
|
|
|
|
{% data variables.product.prodname_copilot_workspace %} enables you to work on your pull requests in one place - on {% data variables.product.github %} - from pull request creation to merge.
|
|
|
|
{% data variables.product.prodname_copilot_short %} can help with pull requests in other ways too. These are explained in separate articles. {% data variables.product.prodname_copilot_short %} can:
|
|
* Write a pull request summary for you - see [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot).
|
|
* Review a pull request for you - see [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review).
|
|
* Suggest fixes for coding problems identified by {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} - see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
|
|
|
|
### Benefits of {% data variables.product.prodname_copilot_workspace %}
|
|
|
|
{% data variables.product.prodname_copilot_workspace %}:
|
|
|
|
* Allows you to work on a pull request without having to switch back and forward between the {% data variables.product.github %} website and your IDE.
|
|
* Gives you easy access to view/test/modify/apply coding suggestions, from {% data variables.product.prodname_copilot_short %} code reviews and {% data variables.product.prodname_copilot_autofix_short %}, as well as reviews by human reviewers.
|
|
* Gives you {% data variables.product.prodname_copilot_short %} code completion suggestions on {% data variables.product.github %}. Previously these were only available in an IDE.
|
|
* Shows you a list of files changed by the pull request, within the browser-based editor, but also allows you to find and edit any file from across the repo.
|
|
* Enables you to build, test, and run your code directly from the {% data variables.product.prodname_copilot_workspace_short %} environment on {% data variables.product.github %}.
|
|
|
|
## Prerequisites
|
|
|
|
Using {% data variables.product.prodname_copilot_workspace %} requires an existing pull request on the {% data variables.product.github %} website and either of the following:
|
|
|
|
* Access to this {% data variables.release-phases.public_preview %} from the waitlist (now closed).
|
|
* Access to {% data variables.product.prodname_GHAS %} (GHAS) features on a private repository owned by an organization on a {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} plan. See [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security).
|
|
|
|
Without access to {% data variables.product.prodname_copilot_workspace %} you can still edit the files in pull requests by going to the **Files changed** tab, clicking the ellipsis (**...**) next to the file you want to edit, and then clicking **Edit file**.
|
|
|
|
## Editing files in a pull request
|
|
|
|
To work on a pull request in {% data variables.product.prodname_copilot_workspace %}:
|
|
|
|
1. Click the **{% octicon "copilot" aria-hidden="true" %} Open in {% data variables.product.prodname_copilot_workspace_short %}** button on the right side of the main page of a pull request.
|
|
|
|
{% data variables.product.prodname_copilot_workspace %} opens, displaying an overview of the pull request.
|
|
|
|
At the left of the {% data variables.product.prodname_copilot_workspace %} window is a list of the files changed by the pull request.
|
|
|
|
|
|
|
|
1. To work on a file that is not currently changed by this pull request, click **Files in this pull request** and, from the dropdown, select **All files in this repository**.
|
|
1. Click a file in the list to open the file in the {% data variables.product.prodname_copilot_workspace_short %} editor.
|
|
|
|
The file is displayed in a diff view. You can change the view if required. See [Changing the {% data variables.product.prodname_copilot_workspace_short %} options](#changing-the-workspace-options) later in this article.
|
|
|
|
You can open and change multiple files before committing your changes.
|
|
|
|
1. After you have finished making changes, click **Review and commit**.
|
|
|
|
The **Commit changes** panel is displayed. {% data variables.product.prodname_copilot_short %} autogenerates a commit message for you, based on the changes you have made. You can edit the message and add an extended description if you want.
|
|
|
|
|
|
|
|
The panel lists the files you have changed. You can expand each file to see the changes you have made.
|
|
|
|
1. Optionally, if you edited multiple files and you decide you don't want to commit all of the changes in a single commit, clear the check box beside the files whose changes you don't want to commit. When you click **Commit changes**, the changes you applied to those files will remain applied but uncommitted, and you can add them to the pull request in a separate commit.
|
|
|
|
> [!NOTE] If you clear the check box beside some files you may need to rewrite the commit message to avoid mentioning the changes to those files.
|
|
|
|
1. Click **Commit changes**.
|
|
|
|
Alternatively, click **Reset all changes** to return the files to their current state in the pull request, losing the changes you made in the {% data variables.product.prodname_copilot_workspace_short %} editor panel. Resetting your changes cannot be undone.
|
|
|
|
## Using {% data variables.product.prodname_copilot_short %} to work on pull request comments
|
|
|
|
You can use {% data variables.product.prodname_copilot_workspace %} to work through all comments on your pull request, one after the other, and then commit any changes you choose to make in a single commit.
|
|
|
|
1. On a comment that includes a code change suggestion, click **Open in {% data variables.product.prodname_copilot_workspace_short %}**.
|
|
|
|
|
|
|
|
{% data variables.product.prodname_copilot_workspace %} opens, displaying the suggested change in the Suggestions panel on the right of the {% data variables.product.prodname_copilot_workspace_short %} window.
|
|
|
|
1. Review the suggested change, then click one of the two buttons at the bottom of the Suggestions panel:
|
|
|
|
* **Apply** - If you agree with the suggested change.
|
|
* **Dismiss** - If you do not want to make the suggested change.
|
|
|
|
1. If there are multiple comments in the pull request, you can step through to the next comment by clicking the **>** arrow at the bottom of the Suggestions panel.
|
|
|
|
|
|
|
|
1. Optionally, to see a list of all of the comments in the pull request, click the back arrow at the top left of the Suggestions panel.
|
|
|
|
|
|
|
|
If you have accepted or dismissed any suggestions, these are shown within "applied" and "dismissed" dropdowns, which make it easy to see which suggestions you have not yet dealt with.
|
|
|
|
|
|
|
|
1. After you have finished reviewing the suggested changes, click **Review and commit**.
|
|
1. Optionally, if you decide you don't want to commit all of the applied changes in a single commit, clear the check box beside the files whose changes you don't want to commit. When you click **Commit changes**, the changes you applied to those files will remain applied but uncommitted, and you can add them to the pull request in a separate commit.
|
|
1. Click **Commit changes**.
|
|
|
|
Alternatively, click **Reset all changes** to return the suggestions to their initial state, losing the apply or dismiss choices you made, and losing any changes you made by editing files directly in the {% data variables.product.prodname_copilot_workspace_short %} editor panel. Resetting your changes cannot be undone.
|
|
|
|
## Chatting with {% data variables.product.prodname_copilot_short %} about a pull request
|
|
|
|
1. At the top of the {% data variables.product.prodname_copilot_workspace_short %} window, click the {% octicon "copilot" aria-label="Toggle {% data variables.product.prodname_copilot_short %} button.
|
|
1. At the bottom of the {% data variables.product.prodname_copilot_short %} panel, type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box then press <kbd>Enter</kbd>.
|
|
|
|
You can ask questions about:
|
|
|
|
* **The currently displayed file** - for example, "how could I improve this file?"
|
|
* **The whole pull request** - for example, "what frameworks are referenced in this pull request?"
|
|
* **General programming topics** - for example, "what is the latest version of ruby?"
|
|
|
|
For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom).
|
|
|
|
> [!NOTE] Currently not all {% data variables.product.prodname_copilot_chat_short %} features are available in the {% data variables.release-phases.public_preview %} of {% data variables.product.prodname_copilot_workspace %}.
|
|
|
|
## Verifying your changes
|
|
|
|
{% data variables.product.prodname_copilot_workspace_short %} includes a built-in terminal and a quick way to build, run, and test your code.
|
|
|
|
### Opening the terminal
|
|
|
|
To open the terminal, click {% octicon "terminal" aria-label="Toggle console panel" %} at the top right of the {% data variables.product.prodname_copilot_workspace_short %} editor panel.
|
|
|
|
> [!NOTE] The terminal requires a codespace to be running. If you don't see the {% octicon "terminal" aria-label="Toggle console panel" %} icon, you may need to wait a few seconds for the codespace to start.
|
|
|
|
### Running terminal commands
|
|
|
|
You can type commands directly into the terminal, or you can use quick commands to run commonly used commands with a couple of clicks.
|
|
|
|
#### Configuring personal quick commands
|
|
|
|
You can configure **Build**, **Run**, and **Test** commands that you can use when you work on a specific project in {% data variables.product.prodname_copilot_workspace %}. If commands have already been configured for the repository, you can replace them with alternative commands for your own personal use.
|
|
|
|
1. At the top of the {% data variables.product.prodname_copilot_workspace_short %} window, click **{% octicon "gear" aria-hidden="true" %} Configure**.
|
|
|
|
If **Build**, **Run**, and **Test** quick commands have already been defined, the **{% octicon "play" aria-hidden="true" %} Build** button is displayed instead of **{% octicon "gear" aria-hidden="true" %} Configure**. Click the dropdown arrow beside the **{% octicon "play" aria-hidden="true" %} Build** button and then click **{% octicon "gear" aria-hidden="true" %} Configure** from the dropdown menu.
|
|
|
|
|
|
|
|
1. In the "Configure commands" dialog, enter the commands you want to use for **Build**, **Run**, and **Test** options.
|
|
1. Click **Save**.
|
|
|
|
#### Configuring quick commands for your repository
|
|
|
|
You can set default **Build**, **Run**, and **Test** commands for everyone who uses {% data variables.product.prodname_copilot_workspace %} to work on pull requests for your repository.
|
|
|
|
1. Create or edit a file in the root of your repository called `.devcontainer/devcontainer.json`.
|
|
|
|
> [!NOTE] The `.devcontainer/devcontainer.json` file is a configuration file for codespaces created for a repository. For more information, see [AUTOTITLE](/enterprise-cloud@latest/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#devcontainerjson).
|
|
|
|
1. Add a `commands` section as follows, replacing the example commands shown here with the commands that people working on your repository should use.
|
|
|
|
```json
|
|
{
|
|
"commands": {
|
|
"Build": "make",
|
|
"Run": "./bin/start",
|
|
"Test": "make test"
|
|
}
|
|
}
|
|
```
|
|
|
|
1. Click **Save**.
|
|
|
|
#### Using {% data variables.product.prodname_copilot_workspace_short %} quick commands
|
|
|
|
1. To run the first of the defined quick commands (typically **Build**), click the button at the top of the {% data variables.product.prodname_copilot_workspace_short %} window.
|
|
1. To run a different quick command, click the dropdown arrow beside the button and then click the command you want to run from the dropdown menu.
|
|
|
|
|
|
|
|
1. After clicking **Run**, while the process is running, you can click the dropdown arrow again and choose from options to stop or restart the process, or view the output from the run command.
|
|
|
|
|
|
|
|
#### Previewing a web application
|
|
|
|
If your run command starts a web server, the {% octicon "globe" aria-label="Open preview" %} button is displayed at the top of the {% data variables.product.prodname_copilot_workspace_short %} window.
|
|
|
|
Click this button to preview the server output in a new tab of your browser.
|
|
|
|
## Changing the {% data variables.product.prodname_copilot_workspace_short %} options
|
|
|
|
You can change how files are displayed in {% data variables.product.prodname_copilot_workspace %}.
|
|
|
|
### Changing the diff view
|
|
|
|
1. Click the compare picker icon ({% octicon "git-compare" aria-hidden="true" %}), at the top right of the {% data variables.product.prodname_copilot_workspace_short %} editor panel.
|
|
1. Choose a view option:
|
|
|
|
* **Unified** - Shows changes in a single view, with added lines highlighted in green and removed lines highlighted in red.
|
|
* **Split** - Shows changes in a split view, with the original file on the left and the new file on the right.
|
|
* **Hidden** - Shows the current state of the file in this pull request, without showing what changes the PR makes.
|
|
|
|
### Wrapping long lines
|
|
|
|
1. Click the ellipsis (**...**), at the top right of the {% data variables.product.prodname_copilot_workspace_short %} editor panel.
|
|
1. Click **Wrap lines** to toggle line wrapping on or off.
|