1
0
mirror of synced 2026-01-03 06:04:16 -05:00
Files
docs/content/packages/learn-github-packages/publishing-a-package.md
jmarlena e71021ae66 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>
2021-04-30 16:28:27 -07:00

3.0 KiB

title, intro, product, redirect_from, permissions, versions
title intro product redirect_from permissions versions
Publishing a package You can publish a package to {% data variables.product.prodname_registry %} to make the package available for others to download and re-use. {% data reusables.gated-features.packages %}
/github/managing-packages-with-github-packages/publishing-a-package
/packages/publishing-and-managing-packages/publishing-a-package
Anyone with write permissions for a repository can publish a package to that repository.
free-pro-team enterprise-server github-ae
* >=2.22 *

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

About published packages

You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. {% data variables.product.product_name %} provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, see @Codertocat/hello-world-npm.

{% data reusables.package_registry.public-or-private-packages %} A repository can be connected to more than one package. To prevent confusion, make sure the README and description clearly provide information about each package.

{% if currentVersion == "free-pro-team@latest" %} If a new version of a package fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. For more information, see "About GitHub Security Advisories." {% endif %}

Publishing a package

You can publish a package to {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines.

  1. Create or use an existing access token with the appropriate scopes for the task you want to accomplish. For more information, see "About permissions for {% data variables.product.prodname_registry %}."
  2. Authenticate to {% data variables.product.prodname_registry %} using your access token and the instructions for your package client.
  3. Publish the package using the instructions for your package client.

For instructions specific to your package client, see "Working with a GitHub Packages registry."

After you publish a package, you can view the package on {% data variables.product.prodname_dotcom %}. For more information, see "Viewing packages."