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.
You can integrate GitHub Package Registry with GitHub 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. GitHub's Container registry is optimized for containers and supports Docker and OCI images. For more information on the different package registries that GitHub Package Registry supports, see "Working with a GitHub Package Registry registry."
You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on GitHub. For more information, see "Viewing packages."
Overview of package permissions and visibility
| Permissions | The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the Container registry, they can be defined for specific user or organization accounts. For more information, see "Configuring a package’s access control and visibility." |
| Visibility | Você pode publicar pacotes em um repositório público (público pacotes) para compartilhar com todo o tipo de GitHub 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."
About billing for GitHub Package Registry
O uso de GitHub Package Registry é gratuito para pacotes públicos. For private packages, each account on GitHub.com receives a certain amount of free storage and data transfer, depending on the product used with the account. Qualquer uso para além dos montantes incluídos é controlado por limites de despesa. If you are a monthly-billed customer, your account will have a default spending limit of 0 US dollars (USD), which prevents additional usage of storage or data transfer after you reach the included amounts. Se você pagar a sua conta por fatura, sua conta terá um limite de gastos padrão ilimitado. For more information, see "About billing 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
| Language | Description | Package format | Package client |
|---|---|---|---|
| JavaScript | Node package manager | package.json | npm |
| Ruby | RubyGems package manager | Gemfile | gem |
| Java | Apache Maven project management and comprehension tool | pom.xml | mvn |
| Java | Gradle build automation tool for Java | build.gradle or build.gradle.kts | gradle |
| .NET | NuGet package management for .NET | nupkg | dotnet CLI |
| N/A | Docker container management | Dockerfile | Docker |
For more information about configuring your package client for use with GitHub Package Registry, see "Working with a GitHub Package Registry registry."
For more information about Docker and the Container registry, see "Working with the Container 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 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_TOKENto publish packages associated with the workflow repository.- a PAT to install packages associated with other private repositories (which
GITHUB_TOKENcan'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 package in the GitHub.com user interface or using the REST API. For more information, see the "GitHub Package Registry API."
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 have feedback or feature requests for GitHub Package Registry, use a GitHub Package Registry feedback discussion.
Contact Suporte do GitHub about GitHub Package Registry using our contact form if:
- You experience anything that contradicts the documentation
- You encounter vague or unclear errors
- Your published package contains sensitive data, such as GDPR violations, API Keys, or personally identifying information