Introduction to GitHub Packages

GitHub Package Registry is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects.

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 GitHub Package Registry

GitHub Package Registry is a platform for hosting and managing packages, including containers and other dependencies. GitHub Package Registry combines your source code and packages in one place to provide integrated permissions management and billing, so you can centralize your software development on GitHub Enterprise Server.

You can integrate GitHub Package Registry with GitHub Enterprise Server APIs, GitHub Actions, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions.

GitHub Package Registry offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. For more information on the different package registries that GitHub Package Registry supports, see "Working with a GitHub Package Registry registry."

Diagram showing packages support for the Docker registry, RubyGems, npm, Apache Maven, Gradle, NuGet, and Docker

You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on GitHub Enterprise Server. For more information, see "Viewing packages."

Overview of package permissions and visibility

PermissionsEach package inherits the permissions of the repository where the package is hosted.

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.
VisibilityVocê 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.

For more information, see "About permissions for GitHub Package Registry."

Supported clients and formats

GitHub Package Registry uses the native package tooling commands you're already familiar with to publish and install package versions.

Support for package registries

LanguageDescriptionPackage formatPackage client
JavaScriptNode package managerpackage.jsonnpm
RubyRubyGems package managerGemfilegem
JavaApache Maven project management and comprehension toolpom.xmlmvn
JavaGradle build automation tool for Javabuild.gradle or build.gradle.ktsgradle
.NETNuGet package management for .NETnupkgdotnet CLI
N/ADocker container managementDockerfileDocker

Note: Docker is not supported when subdomain isolation is disabled.

For more information about subdomain isolation, see "Enabling subdomain isolation."

For more information about configuring your package client for use with GitHub Package Registry, see "Working with a GitHub Package Registry registry."

Authenticating to GitHub Package Registry

You need an access token to publish, install, and delete packages.

You can use a personal access token (PAT) to authenticate to GitHub Package Registry or the GitHub Enterprise Server API. When you create a personal access token, you can assign the token different scopes depending on your needs. For more information about packages-related scopes for a PAT, see "About permissions for GitHub Packages."

To authenticate to a GitHub Package Registry registry within a GitHub Actions workflow, you can use:

  • GITHUB_TOKEN to publish packages associated with the workflow repository.
  • a PAT to install packages associated with other private repositories (which GITHUB_TOKEN can't access).

Para obter mais informações sobre GITHUB_TOKEN usado nos fluxos de trabalho de GitHub Actions, consulteAutenticação em um fluxo de trabalho".

Managing packages

You can delete a private or public package in the GitHub Enterprise Server user interface. Or for repo-scoped packages, you can delete a version of a private package using GraphQL.

When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to GitHub Package Registry. For more information, see "Deleting and restoring a package" and "Forming calls with GraphQL."

You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "package webhook event."

Contacting support

If you need support for GitHub Package Registry, please contact your site administrators.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.