GitHub Actions から ECR にsubmodule (private)を含むDocker イメージを push する
概要
GitHub ActionsからAWSのECRにDockerイメージをpushする方法の備忘録です。
pushするリポジトリは、submoduleとしてprivateリポジトリを想定しています。
半日ほどハマったので、備忘録として残しておきます。
はじめに
ECRを利用する場合、GitHubと連携させてGitHub Actionsでリポジトリを更新時に、ECRへDockerイメージを自動でpushする設定を行っている方もいるかと思います。その際、submodule (private) を設定しているときは、GitHub Actionsでsudmoduleの内容を反映する必要があります。
想定状況
submoduleを含まないリポジトリでのGitHub Actionsを使ったECRへのpushは行えている状況を想定しています。これから設定する方は、以下の記事などを参考に設定していただくと良いと思います。
リポジトリの状況
以下のリポジトリを例として説明します。
-
my_utils:- プライベートリポジトリ
-
my_repository:- プライベートリポジトリ
-
my_utilsをsubmoduleとして設定
今回の目的は、my_repositoryのGitHub Actionsで、my_utilsを適切に反映したDocker imageをECRにpushをすることです。
SSH keyの取得・設定
まずは、my_repositoryからプライベートリポジトリmy_utilsをpullするため、my_utilsにpublic key、my_repositoryにprivate keyを設定します。
以下の記事を参考にSSH key取得・設定していただくと良いと思います。
GitHub Actions のワークフローの作成
GitHub Actionsのワークフローを設定します。
今回は、mainブランチにpushがあった際のActionを設定しています。
name: Push ECR
on:
push:
branches: [ main ]
jobs:
build-and-push:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1-node16
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: ap-northeast-1
- uses: actions/checkout@v3
- name: SSH Setting
env:
TOKEN: ${{ secrets.SSH_PRIVATE}}
run: |
mkdir -p /home/runner/.ssh/
echo -e "$SSH_PRIVATE" > /home/runner/.ssh/id_rsa
chmod 600 /home/runner/.ssh/id_rsa
- name: Checkout submodules
shell: bash
run: |
git submodule sync --recursive
git submodule update --init --force --recursive
- name: Login to Amazon ECR
id: login-ecr
uses: aws-actions/amazon-ecr-login@v1
with:
mask-password: 'true'
- name: Build, tag, and push image to Amazon ECR
env:
ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
ECR_REPOSITORY: ${{ secrets.AWS_ECR_REPO_NAME }}
run: |
docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:latest .
docker push $ECR_REGISTRY/$ECR_REPOSITORY:latest
secrets の設定
最後にmain.ymlで指定した4つのsecretsを設定します。
my_repositoryリポジトリのSettingsをクリックして、左側のメニューのSecrets > Actionsの順にクリックします。Actions secretsの画面が開いたら、New repository secretボタンをクリックして、secretsを登録していきます。
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- SSH_PRIVATE
- AWS_ECR_REPO_NAME
参考
Discussion