Note: GitHub Packages is currently in beta for GitHub Enterprise Server 2.22. To join the beta for your your GitHub Enterprise Server instance, use the sign-up form.
About GitHub Packages
GitHub Packages is a platform for hosting and managing packages, including containers and other dependencies. GitHub Packages 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 Packages 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 Packages offers different package registries for commonly used packages, such as for Node, RubyGems, Apache Maven, Gradle, and Nuget.
Viewing packages
You can review the package's README, some metadata like licensing, download statistics, version history, and more on GitHub Enterprise Server. For more information, see "Viewing packages."
About package permissions and visibility
| Package registries | |
|---|---|
| Hosting locations | You can host multiple packages in one repository. |
| 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 | You can publish packages in a public repository (public packages) to share with everyone on your instance, or in a private repository (private packages) to share with collaborators or an organization. |
Supported clients and formats
GitHub Packages uses the native package tooling commands you're already familiar with to publish and install package versions.
Support for package registries
The package types supported on your GitHub Enterprise Server instance may vary since your site administrator can enable or disable support for different package types. For more information, see "Managing GitHub Packages for your enterprise."
If your GitHub Enterprise Server instance has subdomain isolation enabled, then package registries will use PACKAGE-TYPE.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME as the package host URL, replacing PACKAGE-TYPE with the Package namespace. For example, your Dockerfile will be hosted at docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME.
If your GitHub Enterprise Server instance has subdomain isolation disabled, then package registries will use HOSTNAME/_registry/PACKAGE-TYPE/OWNER/REPOSITORY/IMAGE-NAME as the package host URL. For example, your Gemfile will be hosted at HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME, replacing HOSTNAME with the host name of your GitHub Enterprise Server instance.
With subdomain isolation enabled on your GitHub Enterprise Server instance:
| Language | Description | Package format | Package client | Package namespace |
|---|---|---|---|---|
| JavaScript | Node package manager | package.json | npm | npm.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME |
| Ruby | RubyGems package manager | Gemfile | gem | rubygems.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME |
| Java | Apache Maven project management and comprehension tool | pom.xml | mvn | maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME |
| Java | Gradle build automation tool for Java | build.gradle or build.gradle.kts | gradle | maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME |
| .NET | NuGet package management for .NET | nupkg | dotnet CLI | nuget.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME |
| N/A | Docker container management | Dockerfile | Docker | docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME |
With subdomain isolation disabled on your GitHub Enterprise Server instance:
| Language | Description | Package format | Package client | Package namespace |
|---|---|---|---|---|
| JavaScript | Node package manager | package.json | npm | HOSTNAME/_registry/npm/OWNER/REPOSITORY/IMAGE-NAME |
| Ruby | RubyGems package manager | Gemfile | gem | HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME |
| Java | Apache Maven project management and comprehension tool | pom.xml | mvn | HOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME |
| Java | Gradle build automation tool for Java | build.gradle or build.gradle.kts | gradle | HOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME |
| .NET | NuGet package management for .NET | nupkg | dotnet CLI | HOSTNAME/_registry/nuget/OWNER/REPOSITORY/IMAGE-NAME |
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 Packages, see "Package client guides for GitHub Packages."
Authenticating to GitHub Packages
You need an access token to publish, install, and delete packages. You can use a personal access token to authenticate with your username directly to GitHub Packages or the GitHub API. When you create a personal access token, you can assign the token different scopes depending on your needs.
To authenticate to GitHub Packages using a GitHub Actions workflow, you must use GITHUB_TOKEN.
About scopes and permissions for package registries
To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions for that repository.
For example:
- To download and install packages from a repository, your token must have the
read:packagesscope, and your user account must have read permissions for the repository. - To delete a specified version of a private package on GitHub Enterprise Server, your token must have the
delete:packagesandreposcope. Public packages cannot be deleted. For more information, see "Deleting a package."
| Scope | Description | Repository permissions |
|---|---|---|
read:packages | Download and install packages from GitHub Packages | read |
write:packages | Upload and publish packages to GitHub Packages | write |
delete:packages | Delete specified versions of private packages from GitHub Packages | admin |
repo | Upload and delete packages (along with write:packages, or delete:packages) | write, or admin |
When you create a GitHub Actions workflow, you can use the GITHUB_TOKEN to publish and install packages in GitHub Packages without needing to store and manage a personal access token.
For more information, see:
Managing packages
You can delete a version of a private package in the GitHub Enterprise Server user interface or using the GraphQL 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 Packages. For more information, see "Deleting 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 Packages, please contact your site administrators.