Skip to content

Commit 30b957c

Browse files
authored
Create how-to article on creating a .github-private repo (#61781)
1 parent d8d33ae commit 30b957c

4 files changed

Lines changed: 50 additions & 14 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Creating a `.github-private` repository
3+
shortTitle: Create github-private repository
4+
allowTitleToDifferFromFilename: true
5+
intro: 'A `.github-private` repository can serve as a designated source of governance settings for agents and plugins across your enterprise.'
6+
permissions: Enterprise owners
7+
versions:
8+
feature: copilot
9+
contentType: how-tos
10+
category:
11+
- Configure Copilot
12+
- Manage Copilot for a team
13+
---
14+
15+
A `.github-private` repository can house governance settings for your enterprise's custom agent profiles, client permissions, and plugins.
16+
17+
A repository-based governance approach allows users to open pull request with suggestions to improve the settings, and it allows settings changes to be restricted by codeowners and rulesets.
18+
19+
You can create a `.github-private` repository using a template or from scratch.
20+
21+
## Creating a repository for your enterprise governance
22+
23+
1. Choose an organization in your enterprise to own the repository containing your enterprise-level {% data variables.copilot.custom_agents_short %} and governance settings.
24+
1. Navigate to the [governance template repository](https://github.com/docs/custom-agents-template?ref_product=copilot&ref_type=engagement&ref_style=text&ref_plan=enterprise).
25+
1. In the top-right corner, click "Use this template" and create a new repository in your chosen organization named `.github-private`. Settings will apply to members regardless of whether they can access the repository, so choose the visibility based on who should be able to suggest changes:
26+
* To grant **read access to all members** of your enterprise, choose {% octicon "organization" aria-hidden="true" aria-label="organization" %} **Internal**.
27+
* To **manually grant access after creation**, choose {% octicon "lock" aria-hidden="true" aria-label="lock" %} **Private**.
28+
1. Update the template README as needed. Consider including creation guidelines for {% data variables.copilot.custom_agents_short %} or compliance considerations specific to your enterprise.
29+
30+
> [!NOTE]
31+
> Settings in this repository apply to all users on your enterprise's {% data variables.product.prodname_copilot_short %} plan who use a supported client.
32+
33+
## Selecting your repository as your source of governance
34+
35+
{% data reusables.enterprise-accounts.access-enterprise %}
36+
{% data reusables.enterprise-accounts.ai-controls-tab %}
37+
1. On the "Agents" tab, in the "Configuration source" section, select the **Select organization** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click the organization that contains your `.github-private` repository.
38+
39+
The "Configuration summary" on the settings page will display the settings taken from this repository.
40+
41+
## Next steps
42+
* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents)
43+
* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/disable-automatic-commands)
44+
* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/configure-enterprise-plugin-standards)

content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ versions:
66
feature: copilot
77
children:
88
- /prepare-for-custom-agents
9+
- /create-github-private-repo
910
- /configure-enterprise-plugin-standards
1011
- /disable-automatic-commands
1112
- /monitor-agentic-activity

content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,14 @@ category:
1111
- Manage Copilot for a team
1212
---
1313

14-
Enterprise-level {% data variables.copilot.custom_agents_short %} are defined in a specific repository within an organization in your enterprise. Before you can create and use {% data variables.copilot.custom_agents_short %}, you need to create this repository and configure the relevant enterprise settings.
14+
Enterprise-level {% data variables.copilot.custom_agents_short %} are defined in a specific repository within an organization in your enterprise.
1515

16-
The same `.github-private` repository can also be used to configure enterprise plugin standards. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/configure-enterprise-plugin-standards).
16+
Before you can create and use {% data variables.copilot.custom_agents_short %}, you need to create this repository and configure the relevant enterprise settings.
1717

18-
## Creating a repository for your {% data variables.copilot.custom_agents_short %}
18+
## Creating a repository for your enterprise governance
1919

20-
1. Choose an organization in your enterprise to own the repository containing your enterprise-level {% data variables.copilot.custom_agents_short %}.
21-
1. Using the [{% data variables.copilot.custom_agents_short %} template repository](https://github.com/docs/custom-agents-template?ref_product=copilot&ref_type=engagement&ref_style=text&ref_plan=enterprise), create a new repository in your chosen organization named `.github-private`. Set the visibility of the repository as follows:
22-
* To grant **read access to all members** of your enterprise, choose {% octicon "organization" aria-hidden="true" aria-label="organization" %} **Internal**.
23-
* To **manually grant access after creation**, choose {% octicon "lock" aria-hidden="true" aria-label="lock" %} **Private**.
24-
1. Update the template README as needed. Consider including creation guidelines for {% data variables.copilot.custom_agents_short %} or compliance considerations specific to your enterprise.
20+
1. Create a `.github-private` repository for your enterprise governance. If you don't already have a `.github-private` repo, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/create-github-private-repo).
2521

26-
## Enabling and protecting {% data variables.copilot.custom_agents_short %} in your enterprise
27-
28-
{% data reusables.enterprise-accounts.access-enterprise %}
29-
{% data reusables.enterprise-accounts.ai-controls-tab %}
30-
1. In the "{% data variables.copilot.custom_agents_caps_short %}" section, select the **Select organization** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click the organization that contains your {% data variables.copilot.copilot_custom_agent_short %} repository.
3122
1. To automatically configure a ruleset that allows only enterprise owners to edit {% data variables.copilot.agent_profiles %}, in the "Protect agent files using rulesets" section, click **Create ruleset**.
3223

3324
> [!NOTE]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
1. In your enterprise's `.github-private` repository, create the managed settings file at `copilot/{% data variables.copilot.managed_setting_file %}`. If you haven't set a `.github-private` repository as your enterprise's source of agent configuration, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents).
1+
1. In your enterprise's `.github-private` repository, create the managed settings file at `copilot/{% data variables.copilot.managed_setting_file %}`. If you haven't set a `.github-private` repository as your enterprise's source of agent configuration, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/create-github-private-repo).
22

33
The legacy path (`.github/copilot/settings.json`) is also supported.

0 commit comments

Comments
 (0)