Skip to content

Commit 1a7e777

Browse files
authored
One product variable to rule them all (#19115)
Co-authored-by: jmarlena <>
1 parent 2750073 commit 1a7e777

19 files changed

Lines changed: 40 additions & 41 deletions

content/actions/reference/workflow-syntax-for-github-actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -695,11 +695,11 @@ jobs:
695695
```
696696

697697
{% if currentVersion == "free-pro-team@latest" %}
698-
##### Example using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_capitalized_container_registry %}
698+
##### Example using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}
699699

700700
`docker://{host}/{image}:{tag}`
701701

702-
A Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_capitalized_container_registry %}.
702+
A Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}.
703703

704704
```yaml
705705
jobs:

content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ topics:
1616

1717
{% note %}
1818

19-
**Billing update for container image storage:** During the beta phase of the {% data variables.product.prodname_capitalized_container_registry %}, Docker image storage and bandwidth are free for both the previous `docker.pkg.github.com` and current `ghcr.io` hosting services. For more information, see "[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)."
19+
**Billing update for container image storage:** During the beta phase of the {% data variables.product.prodname_container_registry %}, Docker image storage and bandwidth are free for both the previous `docker.pkg.github.com` and current `ghcr.io` hosting services. For more information, see "[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)."
2020

2121
{% endnote %}
2222

content/packages/learn-github-packages/about-permissions-for-github-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The {% data variables.product.prodname_registry %} registries below use reposito
2929

3030
Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of the package separately from a repository that is connected (or linked) to a package.
3131

32-
Currently, only the {% data variables.product.prodname_capitalized_container_registry %} offers granular permissions for your container image packages.
32+
Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages.
3333

3434
### Visibility and access permissions for container images
3535

content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ versions:
1313

1414
Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of a package separately from the repository that it is connected (or linked) to.
1515

16-
Currently, only the {% data variables.product.prodname_capitalized_container_registry %} offers granular permissions for your container image packages.
16+
Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages.
1717

1818
For more information about permissions for repository-scoped packages, packages-related scopes for PATs, or managing permissions for your actions workflows, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages)."
1919

content/packages/learn-github-packages/connecting-a-repository-to-a-package.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ By connecting a repository to a package, the package landing page will show info
5959
$ docker tag 38f737a91f39 ghcr.io/monalisa/hello_docker:latest
6060
```
6161

62-
5. If you haven't already, authenticate to the {% data variables.product.prodname_capitalized_container_registry %}. For more information, see "[Authenticating to the {% data variables.product.prodname_capitalized_container_registry %}](/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images#authenticating-to-the-container-registry)."
62+
5. If you haven't already, authenticate to the {% data variables.product.prodname_container_registry %}. For more information, see "[Authenticating to the {% data variables.product.prodname_container_registry %}](/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images#authenticating-to-the-container-registry)."
6363
{% raw %}
6464
```shell
6565
$ echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin
6666
> Login Succeeded
6767
```
6868
{% endraw %}
69-
6. Push your container image to the {% data variables.product.prodname_capitalized_container_registry %}.
69+
6. Push your container image to the {% data variables.product.prodname_container_registry %}.
7070
```shell
7171
$ docker push ghcr.io/OWNER/IMAGE-NAME:TAG
7272
```

content/packages/learn-github-packages/introduction-to-github-packages.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ versions:
2525

2626
You can integrate {% data variables.product.prodname_registry %} with {% data variables.product.product_name %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions.
2727

28-
{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% if currentVersion == "free-pro-team@latest" %}The {% data variables.product.prodname_capitalized_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)."
28+
{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% if currentVersion == "free-pro-team@latest" %}The {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)."
2929

3030
{% if currentVersion == "free-pro-team@latest" %}
3131

@@ -43,7 +43,7 @@ You can view a package's README, as well as metadata such as licensing, download
4343

4444
| | |
4545
|--------------------|--------------------|
46-
| Permissions | {% if currentVersion == "free-pro-team@latest" %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_capitalized_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted. <br> <br> For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} |
46+
| Permissions | {% if currentVersion == "free-pro-team@latest" %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted. <br> <br> For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} |
4747
| Visibility | {% data reusables.package_registry.public-or-private-packages %} |
4848

4949
For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)."
@@ -83,7 +83,7 @@ For more information about subdomain isolation, see "[Enabling subdomain isolati
8383
For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "[Working with a {% data variables.product.prodname_registry %} registry](/packages/working-with-a-github-packages-registry)."
8484

8585
{% if currentVersion == "free-pro-team@latest" %}
86-
For more information about Docker and the {% data variables.product.prodname_capitalized_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the Docker registry](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)."
86+
For more information about Docker and the {% data variables.product.prodname_container_registry %}, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the Docker registry](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)."
8787
{% endif %}
8888
### Authenticating to {% data variables.product.prodname_registry %}
8989

content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ versions:
2424
You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow.
2525

2626
{% if currentVersion == "free-pro-team@latest" %}
27-
#### Authenticating to the {% data variables.product.prodname_capitalized_container_registry %}
27+
#### Authenticating to the {% data variables.product.prodname_container_registry %}
2828

2929
{% data reusables.package_registry.container-registry-beta %}
3030

content/packages/working-with-a-github-packages-registry/enabling-improved-container-support-with-the-container-registry.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Enabling improved container support with the Container registry
3-
intro: 'To use the {% data variables.product.prodname_capitalized_container_registry %}, you must enable it for your user or organization account.'
3+
intro: 'To use the {% data variables.product.prodname_container_registry %}, you must enable it for your user or organization account.'
44
product: '{% data reusables.gated-features.packages %}'
55
redirect_from:
66
- /packages/getting-started-with-github-container-registry/enabling-improved-container-support
@@ -12,25 +12,25 @@ versions:
1212

1313
{% note %}
1414

15-
**Note:** The {% data variables.product.prodname_capitalized_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. For more information, see "[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)."
15+
**Note:** The {% data variables.product.prodname_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. For more information, see "[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)."
1616

1717
{% endnote %}
1818

1919
{% data reusables.package_registry.docker-vs-container-registry %}
2020

21-
### Enabling the {% data variables.product.prodname_capitalized_container_registry %} for your personal account
21+
### Enabling the {% data variables.product.prodname_container_registry %} for your personal account
2222

2323
Once the {% data variables.product.prodname_container_registry %} is enabled for your personal user account, you can publish containers to the {% data variables.product.prodname_container_registry %} owned by your user account.
2424

25-
To use the {% data variables.product.prodname_capitalized_container_registry %} within an organization, the organization owner must enable the feature for organization members.
25+
To use the {% data variables.product.prodname_container_registry %} within an organization, the organization owner must enable the feature for organization members.
2626

2727
{% data reusables.feature-preview.feature-preview-setting %}
2828
2. On the left, select "Improved container support", then click **Enable**.
2929
![Improved container support](/assets/images/help/settings/improved-container-support.png)
3030

31-
### Enabling the {% data variables.product.prodname_capitalized_container_registry %} for your organization account
31+
### Enabling the {% data variables.product.prodname_container_registry %} for your organization account
3232

33-
Before organization owners or members can publish container images to the {% data variables.product.prodname_capitalized_container_registry %}, an organization owner must enable the feature preview for the organization.
33+
Before organization owners or members can publish container images to the {% data variables.product.prodname_container_registry %}, an organization owner must enable the feature preview for the organization.
3434

3535
{% data reusables.profile.access_org %}
3636
{% data reusables.profile.org_settings %}

content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ versions:
1010
free-pro-team: '*'
1111
---
1212

13-
### Key differences between the {% data variables.product.prodname_capitalized_container_registry %} and the Docker registry
13+
### Key differences between the {% data variables.product.prodname_container_registry %} and the Docker registry
1414

1515
{% data reusables.package_registry.container-registry-beta %}
1616

17-
The {% data variables.product.prodname_capitalized_container_registry %} supersedes the existing {% data variables.product.prodname_registry %} Docker registry and is optimized to support some of the unique needs of containers.
17+
The {% data variables.product.prodname_container_registry %} supersedes the existing {% data variables.product.prodname_registry %} Docker registry and is optimized to support some of the unique needs of containers.
1818

19-
With the {% data variables.product.prodname_capitalized_container_registry %} you can:
19+
With the {% data variables.product.prodname_container_registry %} you can:
2020
- Store container images within your organization and user account, rather than a repository.
2121
- Set granular permissions and visibility independently of repository permissions and visibility.
2222
- Access public container images anonymously.
2323

24-
| | Docker registry| {% data variables.product.prodname_capitalized_container_registry %} |
24+
| | Docker registry| {% data variables.product.prodname_container_registry %} |
2525
|-------------------|--------------------|----|
2626
| Hosting locations | You can host multiple Docker images in one repository. | You can host multiple container images in one organization or user account. |
2727
| Permissions | Each image inherits the permissions of the repository where the image is hosted. <br> <br> For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version. | For each container image, you can choose the access level that others have. The permissions for container image access are separate from your organization and repository permissions.
@@ -31,9 +31,9 @@ Foreign layer support | Doesn't support foreign layers, such as Windows images.
3131

3232
### Billing changes
3333

34-
During the {% data variables.product.prodname_capitalized_container_registry %} beta, both the new {% data variables.product.prodname_container_registry %} and the existing {% data variables.product.prodname_registry %} Docker registry are free of charge. For more information about the {% data variables.product.prodname_registry %} Docker registry, see "[Working with the Docker registry](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)."
34+
During the {% data variables.product.prodname_container_registry %} beta, both the new {% data variables.product.prodname_container_registry %} and the existing {% data variables.product.prodname_registry %} Docker registry are free of charge. For more information about the {% data variables.product.prodname_registry %} Docker registry, see "[Working with the Docker registry](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)."
3535

36-
After the beta, the same billing and storage rates that other {% data variables.product.prodname_registry %} registries use will apply to the {% data variables.product.prodname_capitalized_container_registry %}. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)."
36+
After the beta, the same billing and storage rates that other {% data variables.product.prodname_registry %} registries use will apply to the {% data variables.product.prodname_container_registry %}. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)."
3737

3838
### Domain changes
3939

@@ -42,9 +42,9 @@ The domain for the {% data variables.product.prodname_container_registry %} is `
4242
| Registry | Example URL |
4343
|-----------------|-------------|
4444
| {% data variables.product.prodname_registry %} Docker registry | `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME`
45-
| {% data variables.product.prodname_capitalized_container_registry %} | `ghcr.io/OWNER/IMAGE_NAME`
45+
| {% data variables.product.prodname_container_registry %} | `ghcr.io/OWNER/IMAGE_NAME`
4646

47-
### Authenticating to the {% data variables.product.prodname_capitalized_container_registry %}
47+
### Authenticating to the {% data variables.product.prodname_container_registry %}
4848

4949
{% data reusables.package_registry.feature-preview-for-container-registry %}
5050

@@ -95,7 +95,7 @@ If you have a {% data variables.product.prodname_actions %} workflow that uses a
9595

9696
2. In your {% data variables.product.prodname_actions %} workflow file, update the package url from `https://docker.pkg.github.com` to `ghcr.io`.
9797

98-
3. Add your new {% data variables.product.prodname_container_registry %} authentication personal access token (PAT) as a GitHub Actions secret. The {% data variables.product.prodname_capitalized_container_registry %} does not support using `GITHUB_TOKEN` for your PAT so you must use a different custom variable, such as `CR_PAT`. For more information, see "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)."
98+
3. Add your new {% data variables.product.prodname_container_registry %} authentication personal access token (PAT) as a GitHub Actions secret. The {% data variables.product.prodname_container_registry %} does not support using `GITHUB_TOKEN` for your PAT so you must use a different custom variable, such as `CR_PAT`. For more information, see "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)."
9999

100100
4. In your {% data variables.product.prodname_actions %} workflow file, update the authentication PAT by replacing your Docker registry PAT ({% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}) with a new variable for your {% data variables.product.prodname_container_registry %} PAT, such as {% raw %}`${{ secrets.CR_PAT }}`{% endraw %}.
101101

0 commit comments

Comments
 (0)