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, 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."
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."
For more information about the configuration of GitHub Package Registry on GitHub Enterprise Server, see "Getting started with GitHub Package Registry for your enterprise."
Overview of package permissions and visibility
Permissions | Each 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. |
Visibility | 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. |
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
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 |
Note: When enabling the Docker registry, we highly recommend also enabling subdomain isolation. For more information, 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 "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.