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, and GitHub One. GitHub Packages is not available for private repositories owned by accounts using legacy per-repository plans. For more information, see "GitHub's products."

In this article

About packages

A package is a self-contained and reusable piece of software that includes code and metadata, such as current version number, name, and the package's dependencies, that a developer bundles together in a common place for others to use. Packages simplify using and distributing solutions to common problems such as needing a common framework for developing a project, testing runners and linters to improve code quality, or introducing industry-standard machine learning tools to power your application.

About GitHub Packages

GitHub Packages is a package hosting service, fully integrated with GitHub. 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.

You can publish packages in a public repository (public packages) to share with all of GitHub, or in a private repository (private packages) to share with collaborators or an organization. You can use GitHub roles and teams to limit who can install or publish each package, as packages inherit the permissions of the repository. 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.

You can host multiple packages in one repository and see more information about each package by viewing the package's README, download statistics, version history, and more.

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

About billing for GitHub Packages

GitHub Packages usage is free for public packages. For private packages, each GitHub account receives a certain amount of free storage and data transfer, depending on the product used with the account. By default, your account will have a spending limit of $0, which prevents additional usage of storage or data transfer after you reach the included amounts. If you increase your spending limit above the default of $0, you will be billed for any additional storage or data transfer, also called overages, up to your spending limit. Any coupons on your account do not apply to GitHub Packages overages. For more information, see "About billing for GitHub Packages."

Supported clients and formats

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

GitHub Packages currently supports these clients and formats.

Package clientLanguagePackage formatDescription
npmJavaScriptpackage.jsonNode package manager
gemRubyGemfileRubyGems package manager
mvnJavapom.xmlApache Maven project management and comprehension tool
gradleJavabuild.gradle or build.gradle.ktsGradle build automation tool for Java
dockerN/ADockerfileDocker container management platform
dotnet CLI.NETnupkgNuGet package management for .NET

For more information about configuring your package client for use with GitHub Packages, see "Using GitHub Packages with your project's ecosystem."

About tokens

You need an access token to publish, install, and delete packages in GitHub Packages. You can use a personal access token to authenticate with your username directly to GitHub Packages or the GitHub API. You can use a GITHUB_TOKEN to authenticate using a GitHub Actions workflow.

When you create a personal access token, you can assign the token different scopes depending on your needs. For more information, see "Creating a personal access token" and "Available scopes."

To install or publish a package, 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, 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 "Using GitHub Packages with GitHub Actions."

Managing packages

You can a delete a version of a private package on GitHub 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 have feedback or feature requests for GitHub Packages, use the feedback form for GitHub Packages.

Contact GitHub Support about GitHub Packages 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

Ask a human

Can't find what you're looking for?

Contact us