1
0
mirror of synced 2025-12-25 02:17:36 -05:00
Files
docs/content/packages/publishing-and-managing-packages/publishing-a-package.md
mc f0f6f88d5a 2776 - Update Dependabot feature names in docs to reflect brand guide (#16291)
* update Dependabot variables

* update variables in docs

* update file names, titles and linked text

* fixing more anchors/links

* add redirects

* remove duplicate redirect from
2020-11-03 15:45:49 +00: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
Anyone with write permissions for a repository can publish a package to that repository.
free-pro-team enterprise-server
* >=2.22

{% data reusables.package_registry.packages-ghes-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 contain more than one package. To prevent confusion, make sure the README and description clearly provide information about each package.

{% data reusables.package_registry.package-immutability %}

{% 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" %}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 {% 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 "Using {% data variables.product.prodname_registry %} with your project's ecosystem."

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