1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Merge pull request #39779 from github/repo-sync

Repo sync
This commit is contained in:
docs-bot
2025-08-11 08:36:16 -07:00
committed by GitHub
23 changed files with 204 additions and 65 deletions

View File

@@ -14,7 +14,8 @@ shortTitle: Use SSH over HTTPS port
---
> [!WARNING]
> **{% data variables.product.prodname_ghe_server %} users:** Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
> **{% data variables.product.prodname_ghe_server %} users:** Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
> **{% data variables.enterprise.data_residency %} users:** Accessing {% data variables.enterprise.data_residency %} via SSH over the HTTPS port is currently not supported.
To test if SSH over the HTTPS port is possible, run this SSH command:
@@ -27,9 +28,6 @@ $ ssh -T -p 443 git@ssh.github.com
If that worked, great! If not, you may need to [follow our troubleshooting guide](/authentication/troubleshooting-ssh/error-permission-denied-publickey).
> [!NOTE] The hostname for port 443 is `ssh.{% data variables.product.product_url %}`, not `{% data variables.product.product_url %}`.
> {% ifversion ghec %}
> {% data reusables.enterprise-data-residency.access-domain %}
{% endif %}
Now, to clone the repository, you can run the following command:

View File

@@ -40,6 +40,11 @@ contentType: concepts
> [!NOTE] This version of this article is about custom instructions in Xcode. Click the tabs above for other environments. <!-- markdownlint-disable-line MD027 -->
{% endxcode %}
{% eclipse %}
> [!NOTE] This version of this article is about custom instructions in Eclipse. Click the tabs above for other environments. <!-- markdownlint-disable-line MD027 -->
{% endeclipse %}
## About customizing {% data variables.copilot.copilot_chat %} responses
{% webui %}
@@ -95,6 +100,17 @@ While custom instructions help to add codebase-wide context to each AI workflow,
{% endxcode %}
{% eclipse %}
{% 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 custom instructions file in your repository 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.
There are two types of repository custom instructions you can use to provide context and instructions to {% data variables.copilot.copilot_chat_short %} in Eclipse:
* **Workspace custom instructions** which apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences, in a single file.
* **Project custom instructions** which apply to a specific project.
{% endeclipse %}
{% webui %}
## Using custom instructions
@@ -243,6 +259,26 @@ Common use cases include:
{% endxcode %}
{% eclipse %}
## About repository custom instructions
**Workspace custom instructions** apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences. You can use workspace custom instructions to provide context and instructions to {% data variables.copilot.copilot_chat_short %} in Eclipse.
**Project custom instructions** consist of a single file, `.github/copilot-instructions.md`, that you create in a project. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement chat questions.
Common use cases include:
* **Test generation.** Create instructions for test generation, such as specifying the use of a certain test framework.
* **Code review.** Specify instructions for reviewing code, such as telling a reviewer to look for a specific error in the code.
* **Commit message generation.** Write instructions for generating commit messages, such as format or the type of information to include.
### Example
{% data reusables.copilot.repository-custom-instructions-example %}
{% endeclipse %}
## Writing effective custom instructions
The instructions you add should ideally be short, self-contained statements provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work.
@@ -292,3 +328,15 @@ Answer all questions in less than 1000 characters, and words of no more than 12
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
{% endjetbrains %}
{% xcode %}
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
{% endxcode %}
{% eclipse %}
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
{% endeclipse %}

View File

@@ -44,6 +44,14 @@ This version of this article is for using repository custom instructions in Xcod
{% endxcode %}
{% eclipse %}
> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
This version of this article is for using repository custom instructions in Eclipse. Click the tabs above for instructions on using custom instructions in other environments.
{% endeclipse %}
## About repository custom instructions for {% data variables.product.prodname_copilot_short %}
Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences.
@@ -84,6 +92,12 @@ Repository custom instructions let you provide {% data variables.product.prodnam
{% endxcode %}
{% eclipse %}
* The latest version of the {% data variables.product.prodname_copilot_short %} extension must be installed in Eclipse.
{% endeclipse %}
## Creating a repository custom instructions file
{% jetbrains %}
@@ -143,6 +157,31 @@ Whitespace between instructions is ignored, so the instructions can be written a
{% endxcode %}
{% eclipse %}
Eclipse supports two types of repository custom instructions: workspace and project custom instructions.
To create a workspace custom instructions file, you can use the {% data variables.product.prodname_copilot_short %} settings page. To create a project custom instructions file, you can create the file manually in the project directory.
Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.
### Creating a workspace custom instructions file
1. To open the {% data variables.copilot.copilot_chat_short %} panel, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) in the status bar at the bottom of Eclipse.
1. From the menu, select "Edit preferences".
1. In the left pane, expand {% data variables.product.prodname_copilot %} and click **Custom Instructions**.
1. Select **Enable workspace instructions**.
1. In the "Workspace" section, under "Set custom instructions to guide {% data variables.product.prodname_copilot_short %}'s code suggestions in this workspace", add natural language instructions to the file, in Markdown format.
### Creating a project custom instructions file
1. In the root of your project directory, create a file named `.github/copilot-instructions.md`.
1. Add your custom instructions in natural language, using Markdown format.
Once saved, these instructions will apply to the current project in Eclipse that you open with {% data variables.product.prodname_copilot_short %} enabled.
{% endeclipse %}
{% vscode %}
{% data variables.product.prodname_vscode_shortname %} supports either:

View File

@@ -0,0 +1,67 @@
---
title: Extracting information
shortTitle: Extract information
intro: Copilot Chat in GitHub can help you extract key information from issues and discussions.
versions:
feature: copilot
complexity:
- Simple
octicon: copilot
topics:
- Copilot
contentType: tutorials
---
{% data variables.copilot.copilot_chat %} can help you extract key information from issues and discussions, making it easier to summarize and understand the content. You can ask {% data variables.copilot.copilot_chat_short %} to identify important details, such as action items, deadlines, or specific requests.
## Example scenario 1
You are reviewing a long discussion thread about a feature request. You want to quickly identify the main points and any action items that need to be addressed.
## Example prompt
`Can you summarize the key points and action items from this discussion?`
## Example response
{% data reusables.copilot.example-prompts.response-is-an-example %}
````text
Key Points:
- The feature request aims to improve the user interface for better accessibility.
- There are concerns about the impact on existing users and workflows.
- Action items include gathering feedback from users and conducting usability testing.
Action Items:
- [ ] Gather feedback from users by the end of the week.
- [ ] Conduct usability testing with a focus group next month.
````
## Example scenario 2
You have a number of open issues assigned to you, and you want to extract the deadlines and priorities for each issue to help you prioritize your work.
## Example prompt
`Can you list the open issues assigned to me, along with their deadlines and priorities?`
## Example response
{% data reusables.copilot.example-prompts.response-is-an-example %}
````text
Issue 1:
- Deadline: Next Friday
- Priority: High
Issue 2:
- Deadline: End of the month
- Priority: Medium
Issue 3:
- Deadline: No specific deadline
- Priority: Low
````
## Further reading
{% data reusables.copilot.example-prompts.further-reading-items %}

View File

@@ -7,5 +7,6 @@ topics:
- Copilot
children:
- /creating-diagrams
- /extracting-information
contentType: tutorials
---

View File

@@ -43,3 +43,7 @@ sections:
After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows.
- |
Unexpected elements may appear in the UI on the repo overview page for locked repositories.
- |
The autolink references feature is missing from the repository settings page.
- |
When attempting to open a pull request as a draft in a private or internal repository, users are incorrectly prompted to upgrade their plan.[Updated: 2025-08-11]

View File

@@ -60,3 +60,7 @@ sections:
Admins setting up cluster high availability (HA) may encounter a spokes error when running `ghe-cluster-repl-status` if a new organization and repositories are created before using the `ghe-cluster-repl-bootstrap` command. To avoid this issue, complete the cluster HA setup with `ghe-cluster-repl-bootstrap` before creating new organizations and repositories.
- |
After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance.
- |
The autolink references feature is missing from the repository settings page.
- |
When attempting to open a pull request as a draft in a private or internal repository, users are incorrectly prompted to upgrade their plan.[Updated: 2025-08-11]

View File

@@ -74,3 +74,7 @@ sections:
After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows.
- |
Customers operating at high scale or near capacity may experience unexpected performance degradation, such as slow response times, background job queue spikes, elevated CPU usage, and increased MySQL load. Consider upgrading to {% ifversion ghes = 3.16 %}3.16{% endif %} {% ifversion ghes = 3.17 %}3.17{% endif %} with caution.
- |
The autolink references feature is missing from the repository settings page.
- |
When attempting to open a pull request as a draft in a private or internal repository, users are incorrectly prompted to upgrade their plan.[Updated: 2025-08-11]

View File

@@ -70,3 +70,7 @@ sections:
When publishing npm packages in a workflow after restoring from a backup to GitHub Enterprise Server 3.13.5.gm4 or 3.14.2.gm3, you may encounter a `401 Unauthorized` error from the GitHub Packages service. This can happen if the restore is from an N-1 or N-2 version and the workflow targets the npm endpoint on the backup instance. To avoid this issue, ensure the access token is valid and includes the correct scopes for publishing to GitHub Packages.
- |
Customers operating at high scale or near capacity may experience unexpected performance degradation, such as slow response times, background job queue spikes, elevated CPU usage, and increased MySQL load. Consider upgrading to {% ifversion ghes = 3.16 %}3.16{% endif %} {% ifversion ghes = 3.17 %}3.17{% endif %} with caution.
- |
The autolink references feature is missing from the repository settings page.
- |
When attempting to open a pull request as a draft in a private or internal repository, users are incorrectly prompted to upgrade their plan.[Updated: 2025-08-11]

View File

@@ -1,5 +1,5 @@
Repository custom instructions are currently supported for:
* **{% data variables.copilot.copilot_chat_short %}** in {% data variables.product.prodname_vscode_shortname %}
* **{% data variables.copilot.copilot_coding_agent %}**
* **{% data variables.copilot.copilot_chat_short %}** in {% data variables.product.prodname_vs %}, JetBrains IDEs, Xcode, and on the {% data variables.product.github %} website (`copilot-instructions.md` file only)
* **{% data variables.copilot.copilot_chat_short %}** in {% data variables.product.prodname_vs %}, JetBrains IDEs, Xcode, Eclipse, and on the {% data variables.product.github %} website (`copilot-instructions.md` file only)
* **{% data variables.copilot.copilot_code-review_short %}** (`copilot-instructions.md` file only)

View File

@@ -1,7 +1,7 @@
import fs from 'fs'
import path from 'path'
import frontmatter from 'gray-matter'
import frontmatter from '@gr2m/gray-matter'
import { getLogLevelNumber } from '#src/observability/logger/lib/log-levels.js'
// Replace imports with hardcoded values

63
package-lock.json generated
View File

@@ -10,6 +10,7 @@
"dependencies": {
"@elastic/elasticsearch": "8.13.1",
"@github/failbot": "0.8.3",
"@gr2m/gray-matter": "4.0.3-with-pr-137",
"@horizon-rs/language-guesser": "0.1.1",
"@octokit/plugin-retry": "8.0.1",
"@octokit/request-error": "7.0.0",
@@ -43,7 +44,6 @@
"github-slugger": "^2.0.0",
"glob": "11.0.2",
"got": "^14.4.7",
"gray-matter": "^4.0.3",
"hast-util-from-parse5": "^8.0.3",
"hast-util-to-string": "^3.0.1",
"hastscript": "^9.0.1",
@@ -1614,6 +1614,21 @@
"integrity": "sha512-Yx70pO8A0p7Stnm9knKkUNX8i4bjuwDYZarRkM8JH0Z+ffhpe++oNAPbzGI9GEcGugRHvKuSC6p4YOdoHtTniQ==",
"license": "MIT"
},
"node_modules/@gr2m/gray-matter": {
"version": "4.0.3-with-pr-137",
"resolved": "https://registry.npmjs.org/@gr2m/gray-matter/-/gray-matter-4.0.3-with-pr-137.tgz",
"integrity": "sha512-6prHnKL+WQzCFe64DtUKki7MacXZARwNH3jlocGrOMgGw8AJASl405f/ULz6vjIU9uTDnxwP2N7ZlHEqOX1T6w==",
"license": "MIT",
"dependencies": {
"js-yaml": "^4.1.0",
"kind-of": "^6.0.2",
"section-matter": "^1.0.0",
"strip-bom-string": "^1.0.0"
},
"engines": {
"node": ">=6.0"
}
},
"node_modules/@graphql-inspector/core": {
"version": "6.1.0",
"resolved": "https://registry.npmjs.org/@graphql-inspector/core/-/core-6.1.0.tgz",
@@ -8445,17 +8460,6 @@
"url": "https://opencollective.com/eslint"
}
},
"node_modules/esprima": {
"version": "4.0.1",
"license": "BSD-2-Clause",
"bin": {
"esparse": "bin/esparse.js",
"esvalidate": "bin/esvalidate.js"
},
"engines": {
"node": ">=4"
}
},
"node_modules/esquery": {
"version": "1.5.0",
"dev": true,
@@ -9388,37 +9392,6 @@
"node": "^12.22.0 || ^14.16.0 || ^16.0.0 || >=17.0.0"
}
},
"node_modules/gray-matter": {
"version": "4.0.3",
"license": "MIT",
"dependencies": {
"js-yaml": "^3.13.1",
"kind-of": "^6.0.2",
"section-matter": "^1.0.0",
"strip-bom-string": "^1.0.0"
},
"engines": {
"node": ">=6.0"
}
},
"node_modules/gray-matter/node_modules/argparse": {
"version": "1.0.10",
"license": "MIT",
"dependencies": {
"sprintf-js": "~1.0.2"
}
},
"node_modules/gray-matter/node_modules/js-yaml": {
"version": "3.14.1",
"license": "MIT",
"dependencies": {
"argparse": "^1.0.7",
"esprima": "^4.0.0"
},
"bin": {
"js-yaml": "bin/js-yaml.js"
}
},
"node_modules/has-bigints": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz",
@@ -15013,10 +14986,6 @@
"node": "*"
}
},
"node_modules/sprintf-js": {
"version": "1.0.3",
"license": "BSD-3-Clause"
},
"node_modules/srcset": {
"version": "5.0.0",
"dev": true,

View File

@@ -282,7 +282,7 @@
"github-slugger": "^2.0.0",
"glob": "11.0.2",
"got": "^14.4.7",
"gray-matter": "^4.0.3",
"@gr2m/gray-matter": "4.0.3-with-pr-137",
"hast-util-from-parse5": "^8.0.3",
"hast-util-to-string": "^3.0.1",
"hastscript": "^9.0.1",

View File

@@ -2,7 +2,7 @@ import walk from 'walk-sync'
import { existsSync, lstatSync, unlinkSync } from 'fs'
import path from 'path'
import { readFile, writeFile, readdir } from 'fs/promises'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
import { rimraf } from 'rimraf'
import { mkdirp } from 'mkdirp'
import { difference, isEqual } from 'lodash-es'

View File

@@ -5,7 +5,7 @@ import path from 'path'
import { afterAll, beforeAll, describe, expect, test } from 'vitest'
import { mkdirp } from 'mkdirp'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
import type { FrontmatterVersions } from '@/types'
import { updateContentDirectory } from '../lib/update-markdown'

View File

@@ -4,7 +4,7 @@ import walk from 'walk-sync'
import { mkdirp } from 'mkdirp'
import { execFileSync, execSync } from 'child_process'
import path from 'path'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
import { rimraf } from 'rimraf'
import { updateContentDirectory } from '../../automated-pipelines/lib/update-markdown'

View File

@@ -1,5 +1,5 @@
import { addError, filterTokens } from 'markdownlint-rule-helpers'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
// Adds an error object with details conditionally via the onError callback
export function addFixErrorDetail(onError, lineNumber, expected, actual, range, fixInfo) {

View File

@@ -5,7 +5,7 @@ import walk from 'walk-sync'
import yaml from 'js-yaml'
import { isRegExp, setWith } from 'lodash-es'
import filenameToKey from './filename-to-key'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
interface DataDirectoryOptions {
preprocess?: (content: string) => string

View File

@@ -2,7 +2,7 @@ import fs from 'fs'
import path from 'path'
import yaml from 'js-yaml'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
import { merge, get } from 'lodash-es'
import languages from '@/languages/lib/languages'

View File

@@ -1,4 +1,4 @@
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
import { validateJson } from '@/tests/lib/validate-json-schema'
@@ -15,7 +15,8 @@ function readFrontmatter(markdown, opts = {}) {
const reason = e.reason
? // make this common error message a little easier to understand
e.reason.startsWith('can not read a block mapping entry;')
e.reason.startsWith('can not read a block mapping entry;') ||
e.reason === 'bad indentation of a mapping entry'
? defaultReason
: e.reason
: defaultReason

View File

@@ -65,7 +65,7 @@ I am content.
const expectedError = {
filepath: 'path/to/file.md',
message: 'YML parsing error!',
reason: 'bad indentation of a mapping entry',
reason: 'invalid frontmatter entry',
}
expect(errors[0]).toEqual(expectedError)
})

View File

@@ -2,7 +2,7 @@ import { readFileSync } from 'fs'
import { basename } from 'path'
import { Liquid } from 'liquidjs'
import walk from 'walk-sync'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
import { latest, oldestSupported } from '@/versions/lib/enterprise-server-releases'
import { getContents } from '@/workflows/git-utils'

View File

@@ -1,5 +1,5 @@
import { readFileSync } from 'fs'
import matter from 'gray-matter'
import matter from '@gr2m/gray-matter'
// Filters out files from a list of filePaths
// that have a type property in their frontmatter