Skip to content

Commit 3d8aa1d

Browse files
authored
Merge pull request #9536 from github/repo-sync
repo sync
2 parents e28c4e5 + dc724cf commit 3d8aa1d

File tree

6 files changed

+43
-15
lines changed

6 files changed

+43
-15
lines changed

content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ topics:
88
product: '{% data reusables.gated-features.codespaces %}'
99
shortTitle: Private image registry
1010
---
11+
12+
## About private image registries and {% data variables.product.prodname_codespaces %}
13+
1114
A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. You can create secrets in GitHub to store the access details for a private registry and use them to give your codespace access to images stored in the registry.
1215

1316
When you launch a codespace, {% data variables.product.prodname_codespaces %} checks for three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace.
@@ -18,11 +21,32 @@ When you launch a codespace, {% data variables.product.prodname_codespaces %} ch
1821

1922
You can store secrets at the user, repository, or organization-level, allowing you to share them securely between different codespaces. When you create a set of secrets for a private image registry, you need to replace the “<*>” in the name with a consistent identifier. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" and "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)."
2023

21-
For example, if you had a private image registry in Azure, you could create the following secrets:
24+
If you are setting the secrets at the user or organization level, make sure to assign those secrets to the repository you'll be creating the codespace in by choosing an access policy from the dropdown list.
25+
26+
![Image registry secret example](/assets/images/help/codespaces/secret-repository-access.png)
27+
28+
## Example secrets
29+
30+
For a private image registry in Azure, you could create the following secrets:
2231

2332
```
2433
ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io
2534
ACR_CONTAINER_REGISTRY_USER = acr-user-here
2635
ACR_CONTAINER_REGISTRY_PASSWORD = <PAT>
2736
```
37+
38+
For information on common image registries, see "[Common image registry servers](#common-image-registry-servers)."
39+
2840
![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png)
41+
42+
Once you've added the secrets, you may need to stop and then start the codespace you are in for the new environment variables to be passed into the container. For more information, see "[Suspending or stopping a codespace](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#suspending-or-stopping-a-codespace)."
43+
44+
## Common image registry servers
45+
46+
Some of the common image registry servers are listed below:
47+
48+
- [DockerHub](https://docs.docker.com/engine/reference/commandline/info/) - `https://index.docker.io/v1/`
49+
- [GitHub Container Registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry) - `ghcr.io`
50+
- [Azure Container Registry](https://docs.microsoft.com/azure/container-registry/) - `<registry name>.azurecr.io`
51+
- [Amazon Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html) - `<aws_account_id>.dkr.ecr.<region>.amazonaws.com`
52+
- [Google Cloud Container Registry](https://cloud.google.com/container-registry/docs/overview#registries) - `gcr.io` (US), `eu.gcr.io` (EU), `asia.gcr.io` (Asia)

content/get-started/learning-about-github/githubs-products.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ In addition to the features available with {% data variables.product.prodname_fr
7676
- Draft pull requests
7777
- Team pull request reviewers
7878
- Scheduled reminders
79+
{% ifversion fpt %}
80+
- The option to enable {% data variables.product.prodname_github_codespaces %}
81+
- Organization owners can enable {% data variables.product.prodname_github_codespaces %} for the organization by setting a spending limit and granting user permissions for members of their organization. For more information, see "[Enabling Codespaces for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization)."
82+
{% endif %}
7983

8084
{% data reusables.github-actions.actions-billing %}
8185

lib/rest/static/decorated/api.github.com.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66377,7 +66377,7 @@
6637766377
}
6637866378
],
6637966379
"summary": "Sync a fork branch with the upstream repository",
66380-
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
66380+
"description": "**Note:** This endpoint is currently in beta and subject to change.\n\nSync a branch of a forked repository to keep it up-to-date with the upstream repository.",
6638166381
"tags": [
6638266382
"repos"
6638366383
],
@@ -66417,16 +66417,16 @@
6641766417
"enabledForGitHubApps": true,
6641866418
"previews": [],
6641966419
"category": "repos",
66420-
"subcategory": "merging-upstream"
66420+
"subcategory": "branches"
6642166421
},
6642266422
"slug": "sync-a-fork-branch-with-the-upstream-repository",
6642366423
"category": "repos",
6642466424
"categoryLabel": "Repos",
66425-
"subcategory": "merging-upstream",
66426-
"subcategoryLabel": "Merging upstream",
66425+
"subcategory": "branches",
66426+
"subcategoryLabel": "Branches",
6642766427
"contentType": "application/json",
6642866428
"notes": [],
66429-
"descriptionHTML": "<p>Sync a branch of a forked repository to keep it up-to-date with the upstream repository.</p>",
66429+
"descriptionHTML": "<p><strong>Note:</strong> This endpoint is currently in beta and subject to change.</p>\n<p>Sync a branch of a forked repository to keep it up-to-date with the upstream repository.</p>",
6643066430
"bodyParameters": [
6643166431
{
6643266432
"type": "string",

lib/rest/static/decorated/github.ae.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56049,7 +56049,7 @@
5604956049
}
5605056050
],
5605156051
"summary": "Sync a fork branch with the upstream repository",
56052-
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
56052+
"description": "**Note:** This endpoint is currently in beta and subject to change.\n\nSync a branch of a forked repository to keep it up-to-date with the upstream repository.",
5605356053
"tags": [
5605456054
"repos"
5605556055
],
@@ -56089,16 +56089,16 @@
5608956089
"enabledForGitHubApps": true,
5609056090
"previews": [],
5609156091
"category": "repos",
56092-
"subcategory": "merging-upstream"
56092+
"subcategory": "branches"
5609356093
},
5609456094
"slug": "sync-a-fork-branch-with-the-upstream-repository",
5609556095
"category": "repos",
5609656096
"categoryLabel": "Repos",
56097-
"subcategory": "merging-upstream",
56098-
"subcategoryLabel": "Merging upstream",
56097+
"subcategory": "branches",
56098+
"subcategoryLabel": "Branches",
5609956099
"contentType": "application/json",
5610056100
"notes": [],
56101-
"descriptionHTML": "<p>Sync a branch of a forked repository to keep it up-to-date with the upstream repository.</p>",
56101+
"descriptionHTML": "<p><strong>Note:</strong> This endpoint is currently in beta and subject to change.</p>\n<p>Sync a branch of a forked repository to keep it up-to-date with the upstream repository.</p>",
5610256102
"bodyParameters": [
5610356103
{
5610456104
"type": "string",

lib/rest/static/dereferenced/api.github.com.deref.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282443,7 +282443,7 @@
282443282443
"/repos/{owner}/{repo}/merge-upstream": {
282444282444
"post": {
282445282445
"summary": "Sync a fork branch with the upstream repository",
282446-
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
282446+
"description": "**Note:** This endpoint is currently in beta and subject to change.\n\nSync a branch of a forked repository to keep it up-to-date with the upstream repository.",
282447282447
"tags": [
282448282448
"repos"
282449282449
],
@@ -282543,7 +282543,7 @@
282543282543

282544282544
],
282545282545
"category": "repos",
282546-
"subcategory": "merging-upstream"
282546+
"subcategory": "branches"
282547282547
}
282548282548
}
282549282549
},

lib/rest/static/dereferenced/github.ae.deref.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230547,7 +230547,7 @@
230547230547
"/repos/{owner}/{repo}/merge-upstream": {
230548230548
"post": {
230549230549
"summary": "Sync a fork branch with the upstream repository",
230550-
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
230550+
"description": "**Note:** This endpoint is currently in beta and subject to change.\n\nSync a branch of a forked repository to keep it up-to-date with the upstream repository.",
230551230551
"tags": [
230552230552
"repos"
230553230553
],
@@ -230647,7 +230647,7 @@
230647230647

230648230648
],
230649230649
"category": "repos",
230650-
"subcategory": "merging-upstream"
230650+
"subcategory": "branches"
230651230651
}
230652230652
}
230653230653
},

0 commit comments

Comments
 (0)