🗂

Container registry of GitHub Package を使ってみる

2021/04/10に公開

Docker

GitHub

tech

ドキュメントが見当たらなかったのでメモ程度に。最小構成はこちら:

GitHub Package と GitHub container registry

現在(2021/4/10) GitHubには2つのContainer registry serviceが存在しています。それぞれGitHub Package (docker.pkg.github.com) とGitHub container registry (ghcr.io) という名前になっており、仕様が少しずつ異なります。

	docker.pkg.github.com	ghcr.io
認証方法	`GITHUB_TOKEN` のみ	`GITHUB_TOKEN` とPersonal Access Token
名前空間	Project毎	User / Organization毎
権限	Repositoryと同一	個別に設定
アクセス	GitHub Actionsからのみ	Publicなら誰でも読み込み可能

この記事ではghcr.ioではなくdocker.pkg.github.comを扱います

上の表に書いたとおりdocker.pkg.github.comでは GITHUB_TOKEN しかサポートされません。GITHUB_TOKEN とはGitHub Actions中のみで有効なトークンで、つまりdocker.pkg.github.comは実質GitHub Actionsからしか使えません。ただしGitHubの別プロジェクトのGitHub ActionsからはGitHub上での権限があれば読み込めるわけです。
用途としては使うべきではない言葉なので修正してください第三者に配布するのではなく、主にPrivate Repository等でGitHub上で管理されている権限を使ってコンテナのアクセスも管理したいという目的での使用を想定しているのでしょう。

GitHub Actions の設定

hello-world:latest を取得して docker.pkg.github.com/org-name/repository-name/hello-world:latest として公開するには次の様に設定します

name: Docker

on:
  push:
    branches:
      - main

jobs:
  push:
    runs-on: ubuntu-20.04
    steps:
    - uses: actions/checkout@v1
    - name: build and push docker image
      run: |
        echo "${{ github.token }}" | docker login https://docker.pkg.github.com -u ${{ github.actor }} --password-stdin
        docker pull hello-world:latest
        docker tag hello-world:latest docker.pkg.github.com/${{ github.repository }}/hello-world:latest
        docker push docker.pkg.github.com/${{ github.repository }}/hello-world:latest

アクセストークンは ${{ github.token }} で、ユーザー名は ${{ github.actor }} を使います。あとは通常どおり docker tag で別名をつけて docker push で送信します。

GitHubで編集を提案

GitHub Package と GitHub container registry

GitHub Actions の設定

Discussion