9.3 KiB
title, intro, product, redirect_from, versions
| title | intro | product | redirect_from | versions | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Introduction to GitHub Packages | {% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% if currentVersion == "github-ae@latest" %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects. | {% data reusables.gated-features.packages %} |
|
|
{% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %}
About {% data variables.product.prodname_registry %}
{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% if currentVersion != "github-ae@latest" %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}.
You can integrate {% data variables.product.prodname_registry %} with {% data variables.product.product_name %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions.
{% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% if currentVersion == "free-pro-team@latest" %}The {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see "Working with a {% data variables.product.prodname_registry %} registry."
{% if currentVersion == "free-pro-team@latest" %}
{% else %}
{% endif %}
You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see "Viewing packages."
Overview of package permissions and visibility
| Permissions | {% if currentVersion == "free-pro-team@latest" %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "Configuring a package’s access control and visibility." {% else %}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.{% endif %} |
| Visibility | {% data reusables.package_registry.public-or-private-packages %} |
For more information, see "About permissions for {% data variables.product.prodname_registry %}."
{% if currentVersion == "free-pro-team@latest" %}
About billing for {% data variables.product.prodname_registry %}
{% data reusables.package_registry.packages-billing %} {% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "About billing for {% data variables.product.prodname_registry %}."
{% endif %}
Supported clients and formats
{% data variables.product.prodname_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 |
{% if currentVersion ver_gt "enterprise-server@2.22" %} {% note %}
Note: Docker is not supported when subdomain isolation is disabled.
{% endnote %}
For more information about subdomain isolation, see "Enabling subdomain isolation."
{% endif %}
For more information about configuring your package client for use with {% data variables.product.prodname_registry %}, see "Working with a {% data variables.product.prodname_registry %} registry."
{% if currentVersion == "free-pro-team@latest" %} For more information about Docker and the {% data variables.product.prodname_container_registry %}, see "Working with the Container registry" and "Working with the Docker registry." {% endif %}
Authenticating to {% data variables.product.prodname_registry %}
{% data reusables.package_registry.authenticate-packages %}
Managing packages
{% if currentVersion == "free-pro-team@latest" %} You can delete a package in the {% data variables.product.product_name %} user interface or using the REST API. For more information, see the "{% data variables.product.prodname_registry %} API." {% endif %}
{% if currentVersion ver_gt "enterprise-server@3.0" %} You can delete a private or public package in the {% data variables.product.product_name %} user interface. Or for repo-scoped packages, you can delete a version of a private package using GraphQL. {% endif %}
{% if currentVersion ver_lt "enterprise-server@3.1" %} You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %}
{% if currentVersion == "github-ae@latest" %} You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %}
When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Deleting and restoring a package{% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}Deleting a package{% endif %}" 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 currentVersion == "free-pro-team@latest" %} If you have feedback or feature requests for {% data variables.product.prodname_registry %}, use the feedback form for {% data variables.product.prodname_registry %}.
Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_registry %} 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
{% else %} If you need support for {% data variables.product.prodname_registry %}, please contact your site administrators.
{% endif %}