Skip to main content

Introduction to 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 适用于 GitHub Free、GitHub Pro、面向组织的 GitHub Free、GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server 3.0 或更高版本以及 GitHub AE。 有关升级 GitHub Enterprise Server 实例更多信息,请参阅“关于升级至新版本”和 升级助手以从你当前的发布版本中查找升级路径。

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, 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 package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. For more information on the different package registries that GitHub Packages supports, see "Working with a GitHub Packages registry."

Diagram showing packages support for the Docker registry, RubyGems, npm, Apache Maven, Gradle, NuGet, and Docker

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 Packages on GitHub Enterprise Server, see "Getting started with GitHub Packages for your enterprise."

Overview of package permissions and visibility

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.
Visibility可以在公共存储库存储库中发布包(公共包)以与企业中每个人共享,或者在专用存储库(专用包)中与协作者或组织共享。

For more information, see "About permissions 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.

Support for package registries

LanguageDescriptionPackage formatPackage client
JavaScriptNode package managerpackage.jsonnpm
RubyRubyGems package managerGemfilegem
JavaApache Maven project management and comprehension toolpom.xmlmvn
JavaGradle build automation tool for Javabuild.gradle or build.gradle.ktsgradle
.NETNuGet package management for .NETnupkgdotnet CLI
N/ADocker container managementDockerfileDocker

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 Packages, see "Working with a GitHub Packages registry."

Authenticating to GitHub Packages

需要访问令牌才能发布、安装和删除包。

可使用个人访问令牌 (PAT) 向 GitHub Packages 或 GitHub Enterprise Server API 进行身份验证。 创建个人访问令牌时,可根据需要为令牌分配不同的作用域。 有关 PAT 的包相关范围的详细信息,请参阅“关于 GitHub Packages 的权限”。

要在 GitHub Actions 工作流程内向 GitHub Packages 注册表验证,您可以使用:

  • GITHUB_TOKEN 发布与工作流存储库相关联的包。
  • PAT 来安装与其他专用存储库(GITHUB_TOKEN 无法访问)相关联的包。

有关 GitHub Actions 工作流中使用的 GITHUB_TOKEN 的详细信息,请参阅“工作流中的身份验证”。

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 Packages.

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 need support for GitHub Packages, please contact your site administrators.