Skip to content

Commit 788df65

Browse files
authored
Merge pull request #43648 from github/repo-sync
Repo sync
2 parents 086c97c + 69f6394 commit 788df65

File tree

142 files changed

+45025
-1085
lines changed

Some content is hidden

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

142 files changed

+45025
-1085
lines changed

content/actions/how-tos/manage-runners/use-proxy-servers.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ On Windows machines, the proxy environment variable names are case-insensitive.
3232

3333
{% data reusables.actions.self-hosted-runner-ports-protocols %}
3434

35+
> [!WARNING]
36+
> Self-hosted runners do not support using IP addresses in the `no_proxy` environment variable. If your {% data variables.product.prodname_ghe_server %} instance uses an IP address and you configure `no_proxy` to bypass the proxy for that address, the runner will still fail to connect.
37+
> If your {% data variables.product.prodname_ghe_server %} instance is accessed using an IP address and the connection must bypass the proxy, the runner will fail to connect, even if that IP address is listed in `no_proxy`.
38+
3539
### Example configurations
3640

3741
{% data reusables.actions.environment-variables-as-case-sensitive %}

content/billing/reference/github-license-users.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ category:
3737
* Billing managers
3838
* Anyone with a pending invitation to become a billing manager
3939
* Anyone with a pending invitation to become an outside collaborator on a public repository owned by your organization
40+
* Anyone with a failed invitation to become an organization member or an outside collaborator on a repository owned by your organization
4041

4142
## Organizations on {% data variables.product.prodname_ghe_cloud %}
4243

@@ -53,19 +54,21 @@ category:
5354
If your enterprise does not use {% data variables.product.prodname_emus %}, you will also be billed for each of the following accounts:
5455

5556
* Anyone with a pending invitation to become an organization owner or member
57+
* If the invited user already consumes an enterprise license, a pending organization invitation won't use an additional license—as long as the invitation is sent to their {% data variables.product.github %} username or a verified email address on their account.
5658
* Anyone with a pending invitation to become an outside collaborator on private or internal repositories owned by your organization, excluding forks
5759
* {% data reusables.organizations.org-invite-scim %}
58-
* Inviting an outside collaborator to a repository using their email address temporarily uses an available seat, even if they already have access to other repositories. After they accept the invite, the seat will be freed up again. Inviting them using their username does not temporarily use a seat.
60+
* If the invited user already consumes an enterprise license because they're a collaborator on an internal or private repository in the enterprise, a pending collaborator invitation using their email address for another repository in the enterprise consumes an available seat. After they accept the invite, the seat will be freed up again. Inviting them using their username does not temporarily use a seat.
5961

6062
### People who don't consume licenses
6163

62-
* {% data variables.enterprise.prodname_managed_users_caps %} that are suspended
64+
* Suspended {% data variables.enterprise.prodname_managed_users_caps %}
6365
* Enterprise owners who are not a member or owner of at least one organization in the enterprise
6466
* The user who set up the enterprise
6567
* Enterprise billing managers
6668
* Billing managers for individual organizations
6769
* Anyone with a pending invitation to become a billing manager
6870
* Anyone who is an outside collaborator on a public repository owned by your organization, or who has a pending invitation to become one
71+
* Anyone with a failed invitation to become an organization member or an outside collaborator on a repository owned by your organization
6972
* Guest collaborators who are not organization members or repository collaborators (see [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#guest-collaborators))
7073
* Users of {% data variables.visual_studio.prodname_vss_ghe %} whose accounts on {% data variables.product.prodname_dotcom %} are not linked, and who do not meet any of the other criteria for per-user pricing
7174
* Unaffiliated users: people who have been added to the enterprise, but are not members of any organizations in the enterprise
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: Best practices for selecting pilot repositories
3+
shortTitle: Select pilot repositories
4+
intro: 'The right pilot repositories demonstrate value quickly and prepare your organization for broader enablement of {% data variables.product.prodname_GH_secret_protection %}.'
5+
versions:
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
9+
contentType: concepts
10+
---
11+
12+
Before enabling {% data variables.product.prodname_GH_secret_protection %} organization-wide, run a pilot to validate the solution with a small set of repositories. A pilot helps you refine your rollout strategy, identify workflow adjustments, and demonstrate security value to stakeholders. This article will help you choose the best repositories for your pilot.
13+
14+
A successful pilot requires strategic repository selection. The repositories you choose determine how quickly you can demonstrate value, gather actionable feedback, and prepare for organization-wide adoption.
15+
16+
## Selection criteria
17+
18+
A successful pilot requires strategic repository selection. The repositories you choose determine how quickly you can demonstrate value, gather actionable feedback, and prepare for organization-wide adoption.
19+
20+
When choosing repositories, consider the following criteria.
21+
22+
### Active development and team engagement
23+
24+
Your pilot needs repositories that generate timely feedback on how {% data variables.product.prodname_secret_protection %} fits into daily development work.
25+
26+
* Select repositories with **regular commits and pull requests**. Active repositories generate feedback quickly and show how {% data variables.product.prodname_secret_protection %} fits into real development workflows.
27+
* Choose **teams** that will engage with the pilot. Responsive maintainers will identify workflow adjustments faster and help refine your rollout strategy.
28+
* **Use repository properties** to systematically identify repositories by team, criticality, or other custom attributes. See [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization).
29+
30+
### Known secret exposure
31+
32+
{% ifversion secret-risk-assessment %}
33+
34+
Choose repositories flagged in your secret risk assessment. These repositories are ideal pilot candidates because they demonstrate immediate value by showing secrets that need remediation.
35+
36+
{% else %}
37+
38+
Choose repositories you suspect contain secrets based on past incidents or security reviews. These repositories are ideal pilot candidates because they allow you to validate the tool's effectiveness quickly.
39+
40+
{% endif %}
41+
42+
Prioritize repositories with production credentials, infrastructure configurations, or integrations with critical services. These high-value targets demonstrate the security value of {% data variables.product.prodname_secret_protection %}.
43+
44+
### Technical diversity
45+
46+
Your pilot should validate that {% data variables.product.prodname_secret_protection %} works with your programming languages and tools.
47+
48+
* Include repositories using different programming languages and frameworks. This validates {% data variables.product.prodname_secret_protection %} coverage across your codebase.
49+
* Select repositories with CI/CD pipelines to identify potential deployment impacts early. Understanding these interactions prevents surprises during broader rollout.
50+
51+
### Organizational representation
52+
53+
A successful pilot requires buy-in from different parts of your organization.
54+
55+
* Choose repositories from different teams or business units. Diverse feedback reveals patterns that wouldn't emerge from a single team's experience.
56+
* Include at least one repository that leadership cares about. Executive visibility maintains pilot momentum and facilitates future budget discussions.
57+
58+
### Repositories to avoid initially
59+
60+
Not all repositories make good pilot candidates.
61+
62+
* **Low-activity or archived repositories**: You won't get timely workflow feedback.
63+
* **Experimental or personal repositories**: These repositories don't reflect production patterns.
64+
* **Repositories with complex custom tooling**: Unusual workflows may complicate feedback.
65+
* **Mission-critical repositories with zero change tolerance**: It's best to add these repositories _after_ validating the solution.
66+
67+
## Pilot size by organization
68+
69+
Once you've identified repositories that meet these criteria, determine the size of your pilot. The right pilot size balances gathering sufficient feedback with avoiding team overwhelm.
70+
71+
| Organization size | Number of repositories | Recommendations |
72+
|---|---|---|
73+
| **Small** (under 100 developers) | 3-5 repositories | Start with your most critical projects. |
74+
| **Medium** (100-500 developers) | 5-10 repositories | Select repositories across different teams, including a mix of high-activity and moderate-activity repositories. |
75+
| **Large** (500+ developers) | 10-20 repositories | Ensure broad representation across the organization. Consider a phased approach with waves of repository additions. |
76+
77+
## Before enabling your pilot
78+
79+
Take these steps to set your pilot up for success.
80+
81+
* Confirm repository owners agree to participate. Unwilling teams generate negative feedback that doesn't reflect actual product issues.
82+
* Identify champions within each pilot team. Champions answer questions and keep feedback flowing.
83+
* Document baseline metrics like commit frequency and contributor count. These baselines help you measure pilot impact.
84+
85+
## Further reading
86+
87+
* [Identify repositories for secret protection](https://support.github.com/product-guides/github-advanced-security-secret-protection/get-started/identify-repositories-for-secret-protection) in the GitHub Advanced Security product guides
88+
89+
{% ifversion secret-risk-assessment %}
90+
91+
## Next steps
92+
93+
Now that you've selected your pilot repositories, review pricing and configure {% data variables.product.prodname_GH_secret_protection %}. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets).
94+
95+
{% endif %}

content/code-security/concepts/security-at-scale/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ versions:
88
ghec: '*'
99
contentType: concepts
1010
children:
11+
- /best-practices-for-selecting-pilot-repositories
1112
- /about-enabling-security-features-at-scale
1213
- /about-security-overview
1314
- /about-security-campaigns

content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ category:
1616

1717
## Prerequisites
1818

19-
Before you configure {% data variables.product.prodname_GH_secret_protection %}, you should run the free {% data variables.product.prodname_secret_risk_assessment %} to inform your enablement strategy. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk).
19+
Before you configure {% data variables.product.prodname_GH_secret_protection %}:
20+
21+
* Run the free {% data variables.product.prodname_secret_risk_assessment %} to inform your enablement strategy. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk).
22+
* Review best practices for choosing pilot repositories. See [AUTOTITLE](/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories).
2023

2124
## Configuring {% data variables.product.prodname_GH_secret_protection %}
2225

content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,4 @@ Finally, look for the following indicators, which may require additional prevent
9393

9494
## Next steps
9595

96-
For stronger secret security and additional insights, {% data variables.product.github %} recommends enabling {% data variables.product.prodname_GH_secret_protection %} for all of your repositories. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/protect-your-secrets).
96+
After understanding your secret exposure, select repositories for a {% data variables.product.prodname_GH_secret_protection %} pilot. See [AUTOTITLE](/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories).

content/contributing/writing-for-github-docs/templates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ Optionally, include a bulleted list of related articles the user can reference t
109109
110110
<!-- markdownlint-enable search-replace -->
111111
112-
## Procedural article template
112+
## How-to article template
113113
114-
Use the content model for full instructions and examples on how to write procedural content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/procedural-content-type).
114+
Use the content model for full instructions and examples on writing how-to content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/how-to-content-type).
115115
116116
<!-- markdownlint-disable search-replace -->
117117
@@ -127,7 +127,7 @@ versions:
127127
---
128128

129129
{% comment %}
130-
Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model#procedural to write this article.-- >
130+
Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model to write this article.
131131
Great intros give readers a quick understanding of what's in the article, so they can tell whether it's relevant to them before moving ahead. For more tips, see https://docs.github.com/contributing/writing-for-github-docs/content-model
132132
For product callout info, see https://github.com/github/docs/tree/main/content#product
133133
For product version instructions, see https://github.com/github/docs/tree/main/content#versioning

content/copilot/concepts/agents/coding-agent/about-custom-agents.md

Lines changed: 2 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,9 @@ category:
99
contentType: concepts
1010
---
1111

12-
## About {% data variables.copilot.custom_agents_short %}
12+
{% data reusables.copilot.copilot-cli.custom-agents-about-intro %}
1313

14-
{% data variables.copilot.custom_agents_caps_short %} are specialized versions of the {% data variables.product.prodname_copilot_short %} agent that you can tailor to your unique workflows, coding conventions, and use cases. They act like tailored teammates that follow your standards, use the right tools, and implement team-specific practices. You define these agents once instead of repeatedly providing the same instructions and context.
15-
16-
You define {% data variables.copilot.custom_agents_short %} using Markdown files called {% data variables.copilot.agent_profiles %}. These files specify prompts, tools, and MCP servers. This allows you to encode your conventions, frameworks, and desired outcomes directly into {% data variables.product.prodname_copilot_short %}.
17-
18-
The {% data variables.copilot.agent_profile %} defines the {% data variables.copilot.copilot_custom_agent_short %}'s behavior. When you assign the agent to a task or issue, it instantiates the {% data variables.copilot.copilot_custom_agent_short %}.
19-
20-
## {% data variables.copilot.agent_profile_caps %} format
21-
22-
{% data variables.copilot.agent_profiles_caps %} are Markdown files with YAML frontmatter. In their simplest form, they include:
23-
24-
* **Name**: A unique identifier for the {% data variables.copilot.copilot_custom_agent_short %}.
25-
* **Description**: Explains the agent's purpose and capabilities.
26-
* **Prompt**: Custom instructions that define the agent's behavior and expertise.
27-
* **Tools** (optional): Specific tools the agent can access. By default, agents can access all available tools, including built-in tools and MCP server tools.
28-
29-
{% data variables.copilot.agent_profiles_caps %} can also include MCP server configurations using the `mcp-server` property.
30-
31-
### Example {% data variables.copilot.agent_profile %}
32-
33-
This example is a basic {% data variables.copilot.agent_profile %} with name, description, and prompt configured.
34-
35-
```text
36-
---
37-
name: readme-creator
38-
description: Agent specializing in creating and improving README files
39-
---
40-
41-
You are a documentation specialist focused on README files. Your scope is limited to README files or other related documentation files only - do not modify or analyze code files.
42-
43-
Focus on the following instructions:
44-
- Create and update README.md files with clear project descriptions
45-
- Structure README sections logically: overview, installation, usage, contributing
46-
- Write scannable content with proper headings and formatting
47-
- Add appropriate badges, links, and navigation elements
48-
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
49-
- Make links descriptive and add alt text to images
50-
```
51-
52-
## Where you can configure {% data variables.copilot.custom_agents_short %}
53-
54-
You can define {% data variables.copilot.agent_profiles %} at different levels:
55-
56-
* **Repository level**: Create `.github/agents/CUSTOM-AGENT-NAME.md` in your repository for project-specific agents.
57-
* **Organization or enterprise level**: Create `/agents/CUSTOM-AGENT-NAME.md` in a `.github-private` repository for broader availability.
58-
59-
For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents).
14+
{% data reusables.copilot.copilot-cli.custom-agents-about-details %}
6015

6116
## Where you can use {% data variables.copilot.custom_agents_short %}
6217

0 commit comments

Comments
 (0)