Skip to content

Commit e71021a

Browse files
jmarlenahubwritersarahslucascosti
authored
Packages content redesign (#18847)
* Add actions category name as first commit * Package reorganization: rename articles for "Learning..." and "Managing..." categories (#18880) * Initial prep work for Packages reorg * Make changes for Learning and Managing categories * Match file name to revised article title * Rework packages guides (#18902) * Create new directory * Delete guides directory and index.md link * Remove duplicated redirects to fix test * fix folder name * delete temporary directory of old content * Add Gradle article * Update landing page with new links * Update test to fix CI failure for deleted articles * Update links and titles for reorg-ed articles * Fix broken links Co-authored-by: hubwriter <hubwriter@github.com> * Update more changed article titles in links (#18911) * remove test line to test PR build failure * Add sections to permissions article * Add draft reusable * restore versioning tests * Remove accidental inclusion of new reusable from a different branch * Package registry content redesign updates (#18930) * Update container registry product variable * First round of edits * Update tidbit * Apply suggestions from code review Co-authored-by: hubwriter <hubwriter@github.com> * Update docker-vs-container-registry.md * Update authentication section to resolve bug/confusion * Revisions * Last touchups * Migration from intro article Co-authored-by: hubwriter <hubwriter@github.com> * Add versioned diagrams * Add packages actions revisions (#18956) * Add refreshed content * Update content/packages/managing-github-packages-using-github-actions-workflows/example-workflows-for-publishing-a-package.md Due to tightness of time on this I'm going to commit this suggestion so that I can merge this PR into the Packages megabranch. Co-authored-by: hubwriter <hubwriter@github.com> * Packages reorg: "Introduction to GitHub Packages" article (#18906) * Initial commit. Remove stray comma * Initial CC work - WiP * More changes for the Introduction article * Make changes as per Jessica's review * Fix broken reusable ref * improve test failure message and add clarifying comments * Packages reorganization: More updates to the 'Learn GitHub Packages' articles" (#18961) * Viewing - WiP * More updates to the 'Learn...' category * revisions to intro article * Add permissions article and make a few other streamlined updates * Fix links 🌿 Co-authored-by: jmarlena <> * Apply suggestions from code review * Apply product input * Fix versioning * Apply some straight-forward suggested changes ⚡ Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Apply suggestions from code review * Add "GitHub Packages" before container registry mention * Standardize visibility & permsisions section into a reusable * Add link * Replace outdated link * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * ✂️ cut note * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Superseded rewrite? * bye single-use reusable * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Condense packages & actions conceptual content * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * remove "package registries" * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Add reusable * Add these redirects from the deleted containers conceptual article * Incorporate changes from main into retitled articles 💫 * Missing endif * Fix unexpected redirect behavior * Revamp and consolidate actions access settings * Further reading section * Last fix for now * standardize steps * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: jmarlena <> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
1 parent c8c30c5 commit e71021a

58 files changed

Lines changed: 511 additions & 487 deletions

File tree

Some content is hidden

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

content/actions/guides/about-packaging-with-github-actions.md

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -18,39 +18,7 @@ topics:
1818
{% data reusables.actions.enterprise-github-hosted-runners %}
1919
{% data reusables.actions.ae-beta %}
2020

21-
### About packaging steps
22-
23-
A packaging step is a common part of a continuous integration or continuous delivery workflow. After building and testing your application, a runnable or deployable artifact is produced in the form of a package. For example, a continuous integration workflow for a Java project may run `mvn package` to produce a JAR file. Or, a CI workflow for a Node.js application may create a Docker container.
24-
25-
Depending on the kind of application you're building, this package can be downloaded locally for manual testing, made available for users to download, or deployed to a staging or production environment.
26-
27-
### Packaging in continuous integration workflows
28-
29-
Creating a package at the end of a continuous integration workflow can help during code reviews on a pull request. After building and testing your code, a packaging step can produce a runnable or deployable artifact. Your workflow can then take that artifact and upload it as part of the workflow.
30-
31-
Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced.
32-
33-
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
34-
![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png)
35-
{% else %}
36-
![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png)
37-
{% endif %}
38-
39-
This will let you run the code in the pull request on your machine, which can help with debugging or testing the pull request.
40-
41-
### Workflows for publishing packages
42-
43-
In addition to uploading packaging artifacts for testing in a continuous integration workflow, you can create workflows that build your project and publish packages to a package registry.
44-
45-
* **Publish packages to {% data variables.product.prodname_registry %}**
46-
{% data variables.product.prodname_registry %} can act as a package hosting service for many types of packages. You can choose to share your packages with all of {% data variables.product.prodname_dotcom %}, or private packages to share with collaborators or an organization. For more information, see "[About {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages/about-github-packages)."
47-
48-
You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build out of the main branch easily, by installing it from {% data variables.product.prodname_registry %}.
49-
50-
* **Publish packages to a package registry**
51-
For many projects, publishing to a package registry is performed whenever a new version of a project is released. For example, a project that produces a JAR file may upload new releases to the Maven Central repository. Or, a .NET project may produce a nuget package and upload it to the NuGet Gallery.
52-
53-
You can automate this by creating a workflow that publishes packages to a package registry on every release creation. For more information, see "[Creating releases](/github/administering-a-repository/creating-releases)."
21+
{% data reusables.package_registry.about-packaging-and-actions %}
5422

5523
### Further reading
5624

content/actions/guides/publishing-docker-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You might also find it helpful to have a basic understanding of the following:
3737

3838
- "[Encrypted secrets](/actions/reference/encrypted-secrets)"
3939
- "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)"
40-
- "[Configuring Docker for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages)"
40+
- "[Working with the Docker registry](/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)"
4141

4242
### About image configuration
4343

content/actions/guides/publishing-java-packages-with-gradle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For more information about creating a CI workflow for your Java project with Gra
3232

3333
You may also find it helpful to have a basic understanding of the following:
3434

35-
- "[Configuring npm for use with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)"
35+
- "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)"
3636
- "[Environment variables](/actions/reference/environment-variables)"
3737
- "[Encrypted secrets](/actions/reference/encrypted-secrets)"
3838
- "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)"

content/actions/guides/publishing-java-packages-with-maven.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For more information about creating a CI workflow for your Java project with Mav
3232

3333
You may also find it helpful to have a basic understanding of the following:
3434

35-
- "[Configuring npm for use with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)"
35+
- "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)"
3636
- "[Environment variables](/actions/reference/environment-variables)"
3737
- "[Encrypted secrets](/actions/reference/encrypted-secrets)"
3838
- "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)"

content/actions/guides/publishing-nodejs-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For more information about creating a CI workflow for your Node.js project, see
3333

3434
You may also find it helpful to have a basic understanding of the following:
3535

36-
- "[Configuring npm for use with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)"
36+
- "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)"
3737
- "[Environment variables](/actions/reference/environment-variables)"
3838
- "[Encrypted secrets](/actions/reference/encrypted-secrets)"
3939
- "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)"

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ runs-on: [AE-runner-for-CI]
341341

342342
For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)."
343343

344-
{% else %}
344+
{% else %}
345345
{% data reusables.actions.enterprise-github-hosted-runners %}
346346

347347
#### {% data variables.product.prodname_dotcom %}-hosted runners
@@ -695,11 +695,11 @@ jobs:
695695
```
696696

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

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

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

704704
```yaml
705705
jobs:
@@ -851,7 +851,7 @@ steps:
851851
shell: perl {0}
852852
```
853853

854-
The command used, `perl` in this example, must be installed on the runner.
854+
The command used, `perl` in this example, must be installed on the runner.
855855

856856

857857
{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)."
@@ -1267,7 +1267,7 @@ The Docker image to use as the service container to run the action. The value ca
12671267
{% raw %}
12681268
```yaml
12691269
services:
1270-
myservice1:
1270+
myservice1:
12711271
image: ghcr.io/owner/myservice1
12721272
credentials:
12731273
username: ${{ github.actor }}

content/admin/configuration/enabling-subdomain-isolation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Subdomain isolation mitigates cross-site scripting and other related vulnerabili
1818
When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains.
1919

2020
{% if currentVersion == "enterprise-server@2.22" %}
21-
To use Docker with {% data variables.product.prodname_registry %}, you must also enable subdomain isolation. For more information, see "[Configuring Docker for use with {% data variables.product.prodname_registry %}](/enterprise/{{ currentVersion }}/user/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages)."
21+
To use Docker with {% data variables.product.prodname_registry %}, you must also enable subdomain isolation. For more information, see "[Working with the Docker registry](/enterprise/{{ currentVersion }}/user/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)."
2222

2323
{% data reusables.package_registry.packages-ghes-release-stage %}
2424

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ topics:
1414

1515
{% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About spending limits](#about-spending-limits)."
1616

17-
{% data reusables.package_registry.container-registry-beta-billing-note %}
17+
{% note %}
18+
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)."
20+
21+
{% endnote %}
1822

1923
If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_registry %} usage beyond the amounts including with your account. For more information, see "[Connecting an Azure subscription to your enterprise](/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise)."
2024

0 commit comments

Comments
 (0)