ノート: GitHub Packagesは現在GitHub AEでベータです。
About Docker support
When installing or publishing a Docker image, the Docker registry does not currently support foreign layers, such as Windows images.
Authenticating to GitHub Packages
You need an access token to publish, install, and delete packages.
You can use a personal access token (PAT) to authenticate to GitHub Packages or the GitHub AE API. When you create a personal access token, you can assign the token different scopes depending on your needs. For more information about packages-related scopes for a PAT, see "About permissions for GitHub Packages."
To authenticate to a GitHub Packages registry within a GitHub Actions workflow, you can use:
GITHUB_TOKEN
to publish packages associated with the workflow repository.- a PAT to install packages associated with other private repositories (which
GITHUB_TOKEN
can't access).
GitHub Actionsワークフローで使われるGITHUB_TOKEN
に関する詳しい情報については「ワークフローでの認証」を参照してください。
Authenticating with a personal access token
GitHub Packages内でパッケージを公開及びインストールするためには、適切なスコープで個人アクセストークンを使わなければなりません。 詳しい情報については「GitHub Packagesについて」を参照してください。
You can authenticate to GitHub Packages with Docker using the docker
login command.
To keep your credentials secure, we recommend you save your personal access token in a local file on your computer and use Docker's --password-stdin
flag, which reads your token from a local file.
$ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin
To use this example login command, replace USERNAME
with your GitHub AE username, HOSTNAME
with the URL for Enterprise, and ~/TOKEN.txt
with the file path to your personal access token for GitHub AE.
For more information, see "Docker login."
Publishing an image
ノート: GitHub Packages Dockerレジストリは将来のGitHub AEリリースでコンテナレジストリとともに置き換えられます。これは改善されたコンテナサポートを提供します。
Note: Image names must only use lowercase letters.
GitHub Packages supports multiple top-level Docker images per repository. A repository can have any number of image tags. You may experience degraded service publishing or installing Docker images larger than 10GB, layers are capped at 5GB each. For more information, see "Docker tag" in the Docker documentation.
パッケージを公開した後は、GitHub上でそのパッケージを見ることができます。 詳しい情報については「パッケージの表示」を参照してください。
-
Determine the image name and ID for your docker image using
docker images
.$ docker images > < > > REPOSITORY TAG IMAGE ID CREATED SIZE > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB
-
Using the Docker image ID, tag the docker image, replacing OWNER with the name of the user or organization account that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, HOSTNAME with the hostname of Enterprise, and VERSION with package version at build time.
$ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
-
If you haven't already built a docker image for the package, build the image, replacing OWNER with the name of the user or organization account that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, VERSION with package version at build time, HOSTNAME with the hostname of Enterprise, and PATH to the image if it isn't in the current working directory.
$ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH
-
Publish the image to GitHub Packages.
$ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
Note: You must push your image using
IMAGE_NAME:VERSION
and not usingIMAGE_NAME:SHA
.
Example publishing a Docker image
You can publish version 1.0 of the monalisa
image to the octocat/octo-app
repository using an image ID.
$ docker images
> REPOSITORY TAG IMAGE ID CREATED SIZE
> monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB
# Tag the image with OWNER/REPO/IMAGE_NAME
$ docker tag c75bebcdd211 docker.HOSTNAME/octocat/octo-app/monalisa:1.0
# Push the image to GitHub Packages
$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0
You can publish a new Docker image for the first time and name it monalisa
.
# Build the image with docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
# Assumes Dockerfile resides in the current working directory (.)
$ docker build -t docker.HOSTNAME/octocat/octo-app/monalisa:1.0 .
# Push the image to GitHub Packages
$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0
Downloading an image
ノート: GitHub Packages Dockerレジストリは将来のGitHub AEリリースでコンテナレジストリとともに置き換えられます。これは改善されたコンテナサポートを提供します。
You can use the docker pull
command to install a docker image from GitHub Packages, replacing OWNER with the name of the user or organization account that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, HOSTNAME with the host name of Enterprise, and TAG_NAME with tag for the image you want to install.
$ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME
Note: You must pull the image using IMAGE_NAME:VERSION
and not using IMAGE_NAME:SHA
.