content/packages/learn-github-packages/connecting-a-repository-to-a-package.md

metadata

title: Connecting a repository to a package
intro: >-
  You can connect a repository to a package on {% data variables.product.github
  %}.
product: '{% data reusables.gated-features.packages %}'
redirect_from:
  - >-
    /packages/managing-container-images-with-github-container-registry/connecting-a-repository-to-a-container-image
  - /packages/guides/connecting-a-repository-to-a-container-image
versions:
  fpt: '*'
  ghec: '*'
  ghes: '*'
shortTitle: Connect a repository

When you publish a package that is scoped to a personal account or an organization, the package is not linked to a repository by default. If you connect a package to a repository, the package's landing page will show information and links from the repository, such as the README. You can also choose to have the package inherit its access permissions from the linked repository. For more information, see AUTOTITLE.

Connecting a repository to a user-scoped package on {% data variables.product.prodname_dotcom %}

{% data reusables.package_registry.package-settings-from-user-level %}

1. Search for and then click the name of the package that you want to manage. {% data reusables.package_registry.repository_connection_steps %}

Connecting a repository to an organization-scoped package on {% data variables.product.prodname_dotcom %}

{% data reusables.package_registry.package-settings-from-org-level %}

1. Search for and then click the name of the package that you want to manage. {% data reusables.package_registry.repository_connection_steps %}

Connecting a repository to a container image using the command line

{% data reusables.package_registry.auto-inherit-permissions-note %}

{% ifversion ghes %} {% data reusables.package_registry.container-registry-ghes-beta %} {% endif %}

1. In your Dockerfile, add this line, replacing {% ifversion ghes %}HOSTNAME, {% endif %}OWNER and REPO with your details:

   LABEL org.opencontainers.image.source=https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPO
   

   For example, if you're the user octocat and own my-repo{% ifversion ghes %}, and your {% data variables.product.github %} hostname is github.companyname.com,{% endif %} you would add this line to your Dockerfile:

   LABEL org.opencontainers.image.source=https://{% ifversion fpt or ghec %}github.com{% else %}{% data reusables.package_registry.container-registry-example-hostname %}{% endif %}/octocat/my-repo
   

   For more information, see LABEL in the official Docker documentation and Pre-defined Annotation Keys in the opencontainers/image-spec repository.

2. Build your container image. This example builds an image from the Dockerfile in the current directory and assigns the image name hello_docker.

   docker build -t hello_docker .
   

3. Optionally, review the details of the Docker image you just created.

   $ docker images
   > REPOSITORY          TAG         IMAGE ID       CREATED         SIZE
   > hello_docker        latest      142e665b1faa   5 seconds ago   125MB
   > redis               latest      afb5e116cac0   3 months ago    111MB
   > alpine              latest      a6215f271958   5 months ago    5.29MB
   

4. Assign a name and hosting destination to your Docker image.

   docker tag IMAGE_NAME {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/NEW_IMAGE_NAME:TAG
   

   Replace NAMESPACE with the name of the personal account or organization to which you want the package to be scoped.

   For example:

   docker tag 38f737a91f39 {% ifversion fpt or ghec %}ghcr.io{% elsif ghes %}{% data reusables.package_registry.container-registry-example-hostname %}{% endif %}/octocat/hello_docker:latest
   

5. If you haven't already, authenticate to the {% data variables.product.prodname_container_registry %}. For more information, see AUTOTITLE. {% raw %}

   $ echo $CR_PAT | docker login {% endraw %}{% data reusables.package_registry.container-registry-hostname %}{% raw %} -u USERNAME --password-stdin
   > Login Succeeded
   

   {% endraw %}

6. Push your container image to the {% data variables.product.prodname_container_registry %}.

   docker push {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/IMAGE-NAME:TAG
   

   For example:

   docker push {% ifversion fpt or ghec %}ghcr.io{% elsif ghes %}{% data reusables.package_registry.container-registry-example-hostname %}{% endif %}/octocat/hello_docker:latest
   

Unlinking a repository from a package on GitHub

Unlinking a package from a repository will remove the repository information from the package's landing page and can affect the access pattern depending on whether the package inherits its access permissions from the repository. For more information, see AUTOTITLE. This behavior does not apply to Apache Maven packages, as outlined in AUTOTITLE.

1. On GitHub, navigate to the settings page of the Package you'd like to unlink.

2. On the Package settings page, you will see a Repository source section. If this section is not present, then the Package is not currently linked to a repository.

3. Click on the trash icon in the top right corner of the Repository source section.

It is possible that the Repository source section exists, but there is no trash icon present. This is because a repository source has been defined as part of the packaged code i.e. a package.json file, .gemspec file, however, it is not actually linked to a repository on GitHub. To link the package to a repository, you will need to follow the steps in the section above.

1. Confirm that you would like to unlink the repository from the package with the dialogue.

Migrating a package to another repository

If you currently have a package linked to a repository and you would like to link it to a different repository, this can be done by unlinking the package from the current repository and linking it to the new repository.

1. Follow the steps to unlink it, see Unlinking a repository from a package on {% data variables.product.prodname_dotcom %}.
2. Follow the steps to link the package to the new repository, see Connecting a repository to an organization-scoped package on {% data variables.product.prodname_dotcom %} or Connecting a repository to a user-scoped package on {% data variables.product.prodname_dotcom %}.