Skip to content

Commit baa5765

Browse files
authored
Merge branch 'main' into patch-7
2 parents e685ac9 + 20bd75f commit baa5765

File tree

280 files changed

+13044
-5813
lines changed

Some content is hidden

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

280 files changed

+13044
-5813
lines changed

.dockerignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
.vscode/
55
contributing/
66
docs/
7-
node_modules/
8-
tests/
9-
# Folder is cloned during the Dockerfile build
107
docs-early-access/
8+
node_modules/
119
README.md
10+
tests/

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
# https://git-scm.com/docs/gitignore
55

66
# Site Policy
7-
/content/site-policy/ @github/site-policy-admins
7+
content/site-policy/ @github/site-policy-admins
88

99
# Enterprise
10-
/data/release-notes/**/*.yml @github/docs-content-enterprise
10+
data/release-notes/**/*.yml @github/docs-content-enterprise
1111
src/ghes-releases/lib/enterprise-dates.json @github/docs-content-enterprise
1212

1313
# Requires review of #actions-oidc-integration, docs-engineering/issues/1506

.github/workflows/ready-for-doc-review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Ready for docs-content review
22

3-
# **What it does**: Adds pull requests in the docs-internal repository to the docs-content review board when the "ready-for-doc-review" label is added or when a review by docs-content or docs-reviewers is requested. Adds the "DIY docs" label to the PR if it is connected to a DIY docs issue in the docs-content repo. This workflow is also called as a reusable workflow from other repos including docs-content, docs-strategy, docs-early-access, and github.
3+
# **What it does**: Adds pull requests in the docs-internal repository to the docs-content review board when the "ready-for-doc-review" label is added or when a review by docs-content or docs-reviewers is requested. This workflow is also called as a reusable workflow from other repos including docs-content, docs-strategy, docs-early-access, and github.
44
# **Why we have it**: So that other GitHub teams can easily request reviews from the docs-content team, and so that writers can see when a PR is ready for review
55
# **Who does it impact**: Writers who need to review docs-related PRs
66

.gitignore

Lines changed: 94 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,113 @@
1-
.search-cache
1+
# Test coverage reports
2+
.coverage/
3+
4+
# macOS system files
25
.DS_Store
6+
7+
# Environment variables (contains secrets)
38
.env
4-
.vscode/settings.json
5-
.idea/
6-
/node_modules/
7-
npm-debug.log
8-
coverage/
9-
/assets/images/early-access
10-
/content/early-access
11-
/data/early-access
12-
/src/dev-toc/static
13-
.next
9+
10+
# ESLint cache for faster linting
1411
.eslintcache
15-
*.tsbuildinfo
16-
/translations/
12+
13+
# JetBrains IDE files
14+
.idea/
15+
16+
# Tracks package-lock.json installation state
17+
.installed.package-lock.json
18+
19+
# Linkinator full site link check results
20+
.linkinator/
21+
22+
# Next.js build output
23+
.next/
24+
25+
# Node.js version specification
1726
.node-version
18-
.linkinator/full.log
19-
next-env.d.ts
20-
nohup.out
2127

22-
# blc: broken link checker
28+
# Precomputed page info cache (brotli compressed)
29+
.pageinfo-cache.json.br
30+
31+
# getRemoteJSON() disk cache for archived content
32+
.remotejson-cache/
33+
34+
# VS Code workspace settings
35+
.vscode/settings.json
36+
37+
# TypeScript incremental build info
38+
*.tsbuildinfo
39+
40+
# Early access images from docs-early-access repo
41+
assets/images/early-access/
42+
43+
# Accidentally committed file that should be ignored
44+
assets/images/help/writing/unordered-list-rendered (1).png
45+
46+
# Old broken link checker output
2347
blc_output.log
48+
49+
# Old internal broken link checker output
2450
blc_output_internal.log
51+
52+
# Old broken links report
2553
broken_links.md
26-
# This one is purely for historical reasons because so many people might
27-
# still have these files on their disk.
28-
lib/redirects/.redirects-cache*.json
2954

55+
# Early access content from docs-early-access repo
56+
content/early-access/
57+
58+
# Test coverage reports
59+
coverage/
60+
61+
# Early access data from docs-early-access repo
62+
data/early-access/
3063

31-
# Logs from scripts
32-
*/logs/
64+
# Cloned for Elasticsearch indexing data
65+
docs-internal-data/
66+
67+
# External link checker cache database
3368
external-link-checker-db.json
3469

35-
# Playwright related
36-
/test-results/
37-
/playwright-report/
38-
/playwright/.cache/
70+
# Historical redirects cache (legacy)
71+
lib/redirects/.redirects-cache*.json
3972

40-
# Automated content source
41-
rest-api-description
42-
semmle-code
43-
models-gateway
73+
# Script execution logs
74+
logs/
4475

45-
.installed.package-lock.json
46-
assets/images/help/writing/unordered-list-rendered (1).png
76+
# GitHub Models API descriptions
77+
models-gateway/
4778

48-
# Used by getRemoteJSON()
49-
.remotejson-cache/
79+
# Next.js TypeScript environment definitions
80+
next-env.d.ts
5081

51-
# Used by precompute-pageinfo
52-
.pageinfo-cache.json.br
82+
# Node.js dependencies
83+
node_modules/
5384

54-
# Cloned and used for indexing Elasticsearch data
55-
docs-internal-data/
85+
# Background process output
86+
nohup.out
87+
88+
# NPM debug logs
89+
npm-debug.log
90+
91+
# Playwright test reports
92+
playwright-report/
5693

57-
# For intermediate data (like scraping for Elasticsearch indexing)
94+
# Playwright browser cache
95+
playwright/.cache/
96+
97+
# REST API OpenAPI descriptions
98+
rest-api-description/
99+
100+
# CodeQL CLI documentation source
101+
semmle-code/
102+
103+
# Development table of contents static HTML files
104+
src/dev-toc/static/
105+
106+
# Playwright test result artifacts
107+
test-results/
108+
109+
# Temporary data files
58110
tmp/
111+
112+
# Localized content from translation repositories
113+
translations/

.prettierignore

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,2 @@
11
data/release-notes/
22
src/bookmarklets/
3-
/.next/
4-
5-
/.coverage
6-
/coverage
7-
8-
# Automated content source
9-
rest-api-description
10-
semmle-code

CHANGELOG.md

Lines changed: 62 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,111 @@
11
# Docs changelog
22

3+
**4 September 2025**
4+
5+
We've updated the documentation to remove references to Copilot coding guidelines.
6+
7+
Coding guidelines, which were previously deprecated, have now been removed as a way of customizing Copilot responses. You should now use Copilot custom instructions.
8+
9+
See: [Configure custom instructions for GitHub Copilot](https://docs.github.com/copilot/how-tos/configure-custom-instructions)
10+
11+
<hr>
12+
13+
**4 September 2025**
14+
15+
In addition to repository-wide custom instructions, specified in the `.github/copilot-instructions.md` file, Copilot Code Review now supports:
16+
17+
* Path-specific custom instructions, specified in `.github/instructions/NAME.instructions.md` files.
18+
* Custom instructions specified in the organization settings for Copilot.
19+
20+
We have updated several articles in the GitHub documentation accordingly. We have also made changes to clarify the difference between the various types of custom instructions for Copilot Code Review, Copilot Chat, and Copilot Coding Agent.
21+
22+
For example, see: [Adding repository custom instructions for GitHub Copilot](https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=webui).
23+
24+
<hr>
25+
26+
**3 September 2025**
27+
28+
We’ve updated [Choosing your enterprise’s plan for GitHub Copilot](https://docs.github.com/en/copilot/get-started/choose-enterprise-plan) to better highlight the long-term benefits of the Copilot Enterprise (CE) plan. The updated content focuses on the key advantages of CE, such as increased access to premium requests and earlier availability of new models.
29+
30+
<hr>
31+
32+
**2 September 2025**
33+
34+
We've added documentation for support of Copilot code review in Xcode.
35+
36+
See: [Using GitHub Copilot code review](https://docs.github.com/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=xcode)
37+
38+
<hr>
39+
40+
**2 September 2025**
41+
42+
We've published a new customization library for GitHub Copilot: a curated collection of examples you can copy, adjust, and use to enhance your experience with Copilot. This library is designed to inspire and educate people on the options available to customize Copilot responses.
43+
44+
We've included examples of custom instructions (widely supported) and prompt files (supported in VS Code only). The examples cover scenarios such as debugging, onboarding, and accessibility. We look forward to adding more examples over time.
45+
46+
See: [Customization library](https://docs.github.com/copilot/tutorials/customization-library).
47+
48+
<hr>
49+
350
**28 August 2025**
451

552
We've published an article about the new AI-powered issue intake tool, which automates incoming issue analysis and triage for OS maintainers.
653

7-
See: [Triaging an issue with AI](https://docs.github.com/en/issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai).
54+
See: [Triaging an issue with AI](https://docs.github.com/issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai).
855

956
<hr>
1057

1158
**26 August 2025**
1259

1360
xAI Grok Code Fast 1 is now available in public preview for GitHub Copilot. Grok Code Fast 1 is slowly rolling out to all paid Copilot plans and you will be able to access the model in Visual Studio Code (Agent, Ask, and Edit modes).
1461

15-
See: [Supported AI models in GitHub Copilot](https://docs.github.com/en/copilot/reference/ai-models/supported-models).
62+
See: [Supported AI models in GitHub Copilot](https://docs.github.com/copilot/reference/ai-models/supported-models).
1663

1764
<hr>
1865

1966
**15 August 2025**
2067

2168
When interacting with the GitHub MCP server for a public repository, push protection blocks secrets from appearing in AI-generated responses and also prevents secrets from being included in any actions you perform, such as creating an issue.
2269

23-
See [Working with push protection and the GitHub MCP server](https://docs.github.com/en/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server).
70+
See [Working with push protection and the GitHub MCP server](https://docs.github.com/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server).
2471

2572
<hr>
2673

2774
**12 August 2025**
2875

2976
OpenAI GPT-5 is now available in public preview for GitHub Copilot. GPT-5 is slowly rolling out to all paid Copilot plans and you will be able to access the model in GitHub Copilot Chat on github.com and Visual Studio Code (Agent, Ask, and Edit modes).
3077

31-
See [Supported AI models in Copilot](https://docs.github.com/en/copilot/reference/ai-models/supported-models).
78+
See [Supported AI models in Copilot](https://docs.github.com/copilot/reference/ai-models/supported-models).
3279

3380
<hr>
3481

3582
**12 August 2025**
3683

3784
We’ve updated the documentation for Copilot repository custom instructions to go with the release that now brings this feature to the Eclipse IDE.
3885

39-
See: [Adding repository custom instructions for GitHub Copilot](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=eclipse) and [About customizing GitHub Copilot Chat responses](https://docs.github.com/en/copilot/concepts/response-customization?tool=eclipse).
86+
See: [Adding repository custom instructions for GitHub Copilot](https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=eclipse) and [About customizing GitHub Copilot Chat responses](https://docs.github.com/copilot/concepts/response-customization?tool=eclipse).
4087

4188
<hr>
4289

4390
**12 August 2025**
4491

45-
We have added a tutorial for using Copilot to create Mermaid diagrams at [Creating Diagrams](https://docs.github.com/en/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-diagrams).
92+
We have added a tutorial for using Copilot to create Mermaid diagrams at [Creating Diagrams](https://docs.github.com/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-diagrams).
4693

4794
<hr>
4895

4996
**4 August 2025**
5097

51-
To address common pain points that developers face when remediating a leaked secret, we created a new article, "[Remediating a leaked secret](https://docs.github.com/en/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret)".
98+
To address common pain points that developers face when remediating a leaked secret, we created a new article, "[Remediating a leaked secret](https://docs.github.com/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret)".
5299

53100
The new guide incorporates cross-platform GitHub tools, as well as opinionated guidance from GitHub's secret scanning team, to walk the developer through a thorough remediation process.
54101

55-
It also clearly communicates the risks of leaked secrets, the challenges of remediation, and the value of enabling [GitHub Secret Protection](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security#github-secret-protection).
102+
It also clearly communicates the risks of leaked secrets, the challenges of remediation, and the value of enabling [GitHub Secret Protection](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security#github-secret-protection).
56103

57104
<hr>
58105

59106
**28 July 2025**
60107

61-
We have restructured the general "[Billing and payments](https://docs.github.com/en/billing)" articles to align with the Copilot and Actions docs. In addition, we've combined a few old "About" articles to directly answer common questions that new users have: [How GitHub billing works](https://docs.github.com/en/billing/get-started/how-billing-works) and [Introduction to billing and licensing](https://docs.github.com/en/billing/get-started/introduction-to-billing).
108+
We have restructured the general "[Billing and payments](https://docs.github.com/billing)" articles to align with the Copilot and Actions docs. In addition, we've combined a few old "About" articles to directly answer common questions that new users have: [How GitHub billing works](https://docs.github.com/billing/get-started/how-billing-works) and [Introduction to billing and licensing](https://docs.github.com/billing/get-started/introduction-to-billing).
62109

63110
<hr>
64111

@@ -74,7 +121,7 @@ See: [Using Copilot to work on an issue](https://docs.github.com/copilot/how-tos
74121

75122
We've updated the Copilot documentation to coincide with the release of an improved user interface for configuring the firewall for Copilot coding agent.
76123

77-
See: [Customizing or disabling the firewall for Copilot coding agent](https://docs.github.com/en/copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent).
124+
See: [Customizing or disabling the firewall for Copilot coding agent](https://docs.github.com/copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent).
78125

79126
<hr>
80127

@@ -92,7 +139,7 @@ Many enterprise customers want to measure the downstream impact of Copilot on th
92139

93140
Inspired by [GitHub's latest guidance](https://resources.github.com/engineering-system-success-playbook/), we've published three guides that provide usecases, training resources, and metrics to help you plan and measure your rollout to achieve real-world goals, such as increasing test coverage.
94141

95-
Get started at [Achieving your company's engineering goals with GitHub Copilot](https://docs.github.com/en/copilot/get-started/achieve-engineering-goals).
142+
Get started at [Achieving your company's engineering goals with GitHub Copilot](https://docs.github.com/copilot/get-started/achieve-engineering-goals).
96143

97144
<hr>
98145

@@ -108,20 +155,20 @@ We’ve published a new set of new documentation articles designed to help users
108155

109156
These clear, actionable guides help users:
110157

111-
- **[View metrics for Dependabot alerts](https://docs.github.com/en/enterprise-cloud@latest/code-security/security-overview/viewing-metrics-for-dependabot-alerts)**
158+
- **[View metrics for Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/security-overview/viewing-metrics-for-dependabot-alerts)**
112159
This article is aimed at security and engineering leads who want to learn how to access and interpret key metrics, so they can quickly assess their organization’s exposure and remediation progress.
113160

114-
- **[Understand your organization’s exposure to vulnerable dependencies](https://docs.github.com/en/enterprise-cloud@latest/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/about-your-exposure-to-vulnerable-dependencies)**
161+
- **[Understand your organization’s exposure to vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/about-your-exposure-to-vulnerable-dependencies)**
115162
In this article, security analysts and compliance teams get a deep dive into how vulnerable dependencies are tracked and what these numbers mean for their risk landscape.
116163

117-
- **[Prioritize Dependabot alerts using metrics](https://docs.github.com/en/enterprise-cloud@latest/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/prioritizing-dependabot-alerts-using-metrics)**
164+
- **[Prioritize Dependabot alerts using metrics](https://docs.github.com/enterprise-cloud@latest/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/prioritizing-dependabot-alerts-using-metrics)**
118165
This guide provides engineering managers and remediation teams with strategies for using metrics to focus the team’s efforts where they matter most, making remediation more efficient.
119166

120167
<hr>
121168

122169
**27 June 2025**
123170

124-
We've published a new scenario-based guide for Copilot: [Learning a new programming language with GitHub Copilot](https://docs.github.com/en/copilot/tutorials/learning-a-new-programming-language-with-github-copilot).
171+
We've published a new scenario-based guide for Copilot: [Learning a new programming language with GitHub Copilot](https://docs.github.com/copilot/tutorials/learning-a-new-programming-language-with-github-copilot).
125172

126173
This guide is for developers who are proficient with at least one programming language and want to learn an additional language. It provides information about how you can use Copilot as your personalized learning assistant. It also provides many ready-made prompts that you can use when you are learning a new programming language.
127174

0 commit comments

Comments
 (0)