Skip to content

Commit 3bc26c4

Browse files
authored
Merge pull request #36016 from github/repo-sync
Repo sync
2 parents 66612f2 + 5f5360c commit 3bc26c4

File tree

62 files changed

+3427
-485
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+3427
-485
lines changed
57.7 KB
Loading
90.8 KB
Loading
-4.55 KB
Loading

content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ shortTitle: About troubleshooting
1212

1313
## Troubleshooting your workflows
1414

15+
There are several ways you can troubleshoot failed workflow runs.
16+
17+
{% ifversion copilot %}
18+
19+
### Using {% data variables.product.prodname_copilot %}
20+
21+
If a workflow run fails, you can open a chat with {% data variables.product.prodname_copilot %} for assistance resolving the error. See [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/using-copilot-to-troubleshoot-workflows).
22+
23+
{% endif %}
24+
1525
### Using workflow run logs
1626

1727
Each workflow run generates activity logs that you can view, search, and download. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs).
@@ -31,8 +41,6 @@ If you attempt to cancel a workflow and the cancellation doesn't succeed, make s
3141
To analyze the inefficiencies and reliability of your workflows using metrics, see [AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics).
3242
{% endif %}
3343

34-
## Monitoring self-hosted runners
35-
3644
## Troubleshooting self-hosted runners
3745

3846
If you use self-hosted runners, you can view their activity and diagnose common issues.

content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ versions:
88
ghec: '*'
99
children:
1010
- /about-troubleshooting-workflows
11+
- /using-copilot-to-troubleshoot-workflows
1112
- /enabling-debug-logging
1213
- /working-with-support-for-github-actions
1314
---
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Using Copilot to troubleshoot workflows
3+
intro: 'You can use {% data variables.product.prodname_copilot %} to help resolve failed workflow runs.'
4+
versions:
5+
feature: copilot
6+
shortTitle: Use Copilot
7+
permissions: This feature is available for users on all {% data variables.product.prodname_copilot %} subscription tiers.
8+
---
9+
10+
If a workflow run fails, you can open a chat with {% data variables.product.prodname_copilot %} for assistance resolving the error.
11+
12+
To open a chat about a failed workflow run, you can either:
13+
14+
* Next to the failed check in the merge box, click **{% octicon "kebab-horizontal" aria-hidden="true" %}**, then click **{% octicon "copilot" aria-hidden="true" %} Explain error**.
15+
* In the merge box, click on the failed check. At the top of the workflow run summary page, click **{% octicon "copilot" aria-hidden="true" %} Explain error**.
16+
17+
This opens a chat window with {% data variables.product.prodname_copilot %}, where it will provide instructions to resolve the issue.
18+
19+
>[!NOTE] If you are on a {% data variables.product.prodname_copilot_free %} subscription, this will count towards your monthly chat message limit.

content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,14 @@ If your appliance averages more than 70% CPU utilization, {% data variables.prod
207207
As part of upgrading GitHub Enterprise Server to version 3.13 or later, the Elasticsearch service will be upgraded. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade).
208208
{% endif %}
209209

210-
{% ifversion ghes > 3.14 and ghes < 3.17 %}
210+
{% ifversion ghes > 3.14 %}
211211

212212
## Required root disk size increased to 400GB
213213

214-
New installations of 3.15 or later, or upgrades to 3.15 or later require root disk size of at least 400GB. This capacity is an enforced requirement for the system to boot successfully. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity).
214+
> [!Note]
215+
> The previous root disk size requirement of 400GB for versions 3.15.2 and later has been removed. This requirement was based on analysis of support bundles and support tickets. Some factors, such as logs, put excessive pressure on the root disk which caused appliance issues. After receiving feedback that it's challenging for many customers to procure new hardware, we rolled back the requirement in favor of a gradual approach. We still recommend customers, especially those using standalone or standalone high-availability topologies, upgrade the root disk to 400GB. When you are able to upgrade the root disk to 400GB, see the following instructions.
216+
217+
To customers using standalone or HA topologies, it is recommended that new installations of 3.15 or later, or upgrades to 3.15 to use root disk size of at least 400GB. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity).
215218

216219
{% endif %}
217220

content/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot.md

Lines changed: 86 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,57 @@ topics:
88
- Copilot
99
---
1010

11-
> [!NOTE]
12-
> * This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
13-
> * Custom instructions are currently only supported for {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %}.
1411

15-
## About custom instructions for {% data variables.product.prodname_copilot %}
12+
{% webui %}
13+
14+
{% data reusables.copilot.custom-instructions-note %}
15+
>
16+
> This version of this article is for using custom instructions on the {% data variables.product.github %} website. Click the tabs above for information on using custom instructions in other environments. <!-- markdownlint-disable-line MD027 -->
17+
18+
{% endwebui %}
19+
20+
{% vscode %}
21+
22+
{% data reusables.copilot.custom-instructions-note %}
23+
>
24+
> This version of this article is for using custom instructions in {% data variables.product.prodname_vscode_shortname %}. Click the tabs above for instructions on using custom instructions in other environments. <!-- markdownlint-disable-line MD027 -->
25+
26+
{% endvscode %}
27+
28+
{% visualstudio %}
29+
30+
{% data reusables.copilot.custom-instructions-note %}
31+
>
32+
> This version of this article is for using custom instructions in {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using custom instructions in other environments. <!-- markdownlint-disable-line MD027 -->
33+
34+
{% endvisualstudio %}
35+
36+
## About custom instructions for {% data variables.product.prodname_copilot_chat %}
1637

1738
{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a file that automatically adds this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses.
1839

1940
## Prerequisites
2041

2142
* A custom instructions file (see the instructions below).
22-
* The **Use Instruction Files** ({% data variables.product.prodname_vscode_shortname %}) or **Enable custom instructions** ({% data variables.product.prodname_vs %}) option enabled in your settings. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article.
2343

24-
> [!NOTE] The setting is enabled by default in {% data variables.product.prodname_vscode_shortname %} and disabled by default in {% data variables.product.prodname_vs %}.
44+
{% webui %}
45+
46+
* Your personal choice of whether to use custom instructions must be set to enabled. This is enabled by default. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article.
47+
* During the {% data variables.release-phases.public_preview %}, if you have a {% data variables.product.prodname_copilot_business_short %} {% ifversion ghec %}or {% data variables.product.prodname_copilot_enterprise_short %}{% endif %} subscription, then the organization {% ifversion ghec %}or enterprise{% endif %} from which you receive your subscription must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization){% ifversion ghec %} and [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom){% endif %}.
48+
49+
{% endwebui %}
50+
51+
{% vscode %}
52+
53+
* The **Use Instruction Files** option must be enabled in your settings. This is enabled by default. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article.
54+
55+
{% endvscode %}
56+
57+
{% visualstudio %}
58+
59+
* The **Enable custom instructions** option must be enabled in your settings. This is disabled by default. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article.
60+
61+
{% endvisualstudio %}
2562

2663
## Creating a custom instructions file
2764

@@ -69,27 +106,64 @@ Answer all questions in less than 1000 characters, and words of no more than 12
69106

70107
## Custom instructions in use
71108

72-
The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.product.prodname_copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically attached to requests that you submit in either the {% data variables.product.prodname_copilot_chat_short %} view, or in inline chat, in {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %}.
109+
{% webui %}
110+
111+
The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.product.prodname_copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically added to chat prompts that relate to the repository containing the instructions file.
73112

74-
Custom instructions are not visible in the Chat view or inline chat, but you can verify that they are being used by {% data variables.product.prodname_copilot_short %} by looking at the References list of a response. If custom instructions were added to the prompt that was sent to the model, the `.github/copilot-instructions.md` file is listed as a reference. You can click the reference to open the file.
113+
In immersive mode (the [https://github.com/copilot](https://github.com/copilot) page), you can start a conversation that uses custom instructions by adding, as an attachment, the repository that contains the instructions file.
75114

76-
![Screenshot of the {% data variables.product.prodname_copilot_chat_short %} view in {% data variables.product.prodname_vscode_shortname %} with a reference for the copilot-instructions.md file.](/assets/images/help/copilot/custom-instructions-vscode.png)
115+
Custom instructions are not visible in {% data variables.product.prodname_copilot_chat_short %}, but you can verify that they are being used by {% data variables.product.prodname_copilot_short %} by expanding the list of references at the top of a chat response in the Chat panel. If custom instructions were added to the prompt that was sent to the model, the `.github/copilot-instructions.md` file is listed as a reference.
116+
117+
![Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark organge outline.](/assets/images/help/copilot/custom-instructions-ref-in-github.png)
118+
119+
You can click the reference to open the file.
120+
121+
{% endwebui %}
122+
123+
{% vscode %}
124+
125+
{% data reusables.copilot.custom-instructions-reference %}
126+
127+
![Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark organge outline.](/assets/images/help/copilot/custom-instructions-vscode.png)
128+
129+
{% endvscode %}
130+
131+
{% visualstudio %}
132+
133+
{% data reusables.copilot.custom-instructions-reference %}
134+
135+
![Screenshot of the References popup, showing the 'copilot-instructions.md' file highlighted with a dark organge outline.](/assets/images/help/copilot/custom-instruction-ref-visual-studio.png)
136+
137+
{% endvisualstudio %}
77138

78139
## Enabling or disabling custom instructions
79140

80-
You can choose whether or not to have custom instructions added to your chat questions. To do this, select or clear the option in the settings for the {% data variables.product.prodname_copilot_short %} extension.
141+
You can choose whether or not to have custom instructions added to your chat questions.
142+
143+
{% webui %}
144+
145+
1. Click the {% octicon "kebab-horizontal" aria-label="Conversation options" %} button at the top of the Chat panel, or the top right of the immersive page.
146+
1. Click **Disable custom instructions** or **Enable custom instructions**.
81147

82-
### In {% data variables.product.prodname_vscode_shortname %}
148+
Your choice persists until you change it.
149+
150+
{% endwebui %}
151+
152+
{% vscode %}
83153

84154
1. Open the Setting editor by using the keyboard shortcut <kbd>Command</kbd>+<kbd>,</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>,</kbd> (Linux/Windows).
85155
1. Type `instruction file` in the search box.
86156
1. Select or clear the checkbox under **Code Generation: Use Instruction Files**.
87157

88-
### In {% data variables.product.prodname_vs %}
158+
{% endvscode %}
159+
160+
{% visualstudio %}
89161

90162
1. In the {% data variables.product.prodname_vs %} menu bar, under **Tools**, click **Options**.
91163

92164
![Screenshot of the {% data variables.product.prodname_vs %} menu bar. The "Tools" menu is expanded, and the "Options" item is highlighted with an orange outline.](/assets/images/help/copilot/vs-toolbar-options.png)
93165

94166
1. In the "Options" dialog, type `custom instructions` in the search box.
95167
1. Select or clear the checkbox for **(Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests**.
168+
169+
{% endvisualstudio %}

content/packages/learn-github-packages/about-permissions-for-github-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ To use or manage a package hosted by a package registry, you must use a {% data
6565

6666
For example:
6767
* To download and install packages from a repository, your {% data variables.product.pat_v1 %} must have the `read:packages` scope, and your user account must have read permission.
68-
* To delete a package on {% data variables.product.product_name %}, your {% data variables.product.pat_v1 %} must at least have the `delete:packages` and `read:packages` scope. For more information, see [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package).
68+
* To delete a package, your {% data variables.product.pat_v1 %} must at least have the `delete:packages` and `read:packages` scope. For more information, see [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package).
6969

7070
| Scope | Description | Required permission |
7171
| --- | --- | --- |

content/packages/learn-github-packages/deleting-and-restoring-a-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ To find all of the private packages you have published to {% data variables.prod
8787

8888
For more information about the `deletePackageVersion` mutation, see [AUTOTITLE](/graphql/reference/mutations#deletepackageversion).
8989

90-
You cannot directly delete an entire package using GraphQL, but if you delete every version of a package, the package will no longer show on {% data variables.product.product_name %}.
90+
You cannot directly delete an entire package using GraphQL, but if you delete every version of a package, the package will no longer show on {% data variables.product.github %}.
9191

9292
{% ifversion fpt or ghec %}
9393

0 commit comments

Comments
 (0)