GitHub Enterprise Server 2.22 is currently under limited release as a release candidate.

About GitHub Packages

GitHub Packages 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 Packages is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server 2.22, and GitHub One.

In this article

Did this doc help you?

Note: GitHub Packages is currently in beta for GitHub Enterprise Server 2.22. To join the beta for your 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.

You can integrate GitHub Packages with GitHub Enterprise 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. For more information, see "Viewing packages."

About package permissions and visibility

Package registries
Hosting locationsYou can host multiple packages in one repository.
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.
VisibilityYou 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:

LanguageDescriptionPackage formatPackage clientPackage namespace
JavaScriptNode package managerpackage.jsonnpmnpm.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME
RubyRubyGems package managerGemfilegemrubygems.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME
JavaApache Maven project management and comprehension toolpom.xmlmvnmaven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME
JavaGradle build automation tool for Javabuild.gradle or build.gradle.ktsgradlemaven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME
.NETNuGet package management for .NETnupkgdotnet CLInuget.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME
N/ADocker container managementDockerfileDockerdocker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME

With subdomain isolation disabled on your GitHub Enterprise Server instance:

LanguageDescriptionPackage formatPackage clientPackage namespace
JavaScriptNode package managerpackage.jsonnpmHOSTNAME/_registry/npm/OWNER/REPOSITORY/IMAGE-NAME
RubyRubyGems package managerGemfilegemHOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME
JavaApache Maven project management and comprehension toolpom.xmlmvnHOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME
JavaGradle build automation tool for Javabuild.gradle or build.gradle.ktsgradleHOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME
.NETNuGet package management for .NETnupkgdotnet CLIHOSTNAME/_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 "Using GitHub Packages with your project's ecosystem."

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:packages scope, and your user account must have read permissions for the repository. If the repository is private, your token must also have the repo scope.
  • To delete a specified version of a private package on GitHub Enterprise, your token must have the delete:packages and repo scope. Public packages cannot be deleted. For more information, see "Deleting a package."
ScopeDescriptionRepository permissions
read:packagesDownload and install packages from GitHub Packagesread
write:packagesUpload and publish packages to GitHub Packageswrite
delete:packagesDelete specified versions of private packages from GitHub Packagesadmin
repoInstall, upload, and delete certain packages in private repositories (along with read:packages, write:packages, or delete:packages)read, 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 a delete a version of a private package on GitHub Enterprise 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.

Did this doc help you?