Skip to main content

Publishing a package

You can publish a package to GitHub Package Registry to make the package available for others to download and re-use.

Anyone with write permissions for a repository can publish a package to that repository.

GitHub Package Registry is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server 3.0 or higher, and GitHub AE. For more information about upgrading your GitHub Enterprise Server instance, see "About upgrades to new releases" and refer to the Upgrade assistant to find the upgrade path from your current release version.

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. GitHub Enterprise Server 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.

Você pode publicar pacotes em um repositório público (público pacotes) para compartilhar com todas as pessoas na sua empresa ou em um repositório privado (pacotes privados) para compartilhar com os colaboradores ou uma organização. 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.

Publishing a package

You can publish a package to GitHub Package Registry using any package type enabled for your instance 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 GitHub Package Registry."
  2. Authenticate to GitHub Package 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 GitHub. For more information, see "Viewing packages."