GitHub リポジトリのコードを CodeCommit リポジトリに複製する

こんにちは、島村です。

今回はGitHubリポジトリのコードをCodeCommitへ同期する内容を紹介したいと思います。
たまたま、GitHubで管理しているコードをEC2へ格納する必要があり、CodeCommitからCloneしたいという要件がありました。
GitHub Actions自体あまり使用したことがないので、簡単に設定の定義についても触れていきたいと思います。

早速、記載していきます。

簡易構成図

簡易構成図です。

OpenID Connect のセットアップ

GitHubとAWSの連携はOpenID Connect で行います。
具体的な手順については、弊社エンジニアの福島がブログにまとめているので、こちらを参考にしてみてください。
権限の部分が異なりますので、今回はCodeCommitFullAccessを付与してください。
厳密に制御したい場合は、CodeCommit:GitPush 権限のみでOKです。

blog.serverworks.co.jp

GitHub Actionsの設定

Workflowファイルの作成

GitHub Actionsを利用する場合、リポジトリの直下に.github/workflows/というディレクトリを作成します。
作成したディレクトリの中に、Workflowファイルを用意します。
名前はなんでもいいですが、codecommit-mirror-workflow.ymlという名前で今回は進めます。

yamlファイルの記述

Workflowファイルを記述していきます。
出来上がったworkflowファイルを先に載せておきます。

name: github repository mirror to CodeCommit
on:
  push:
    branches:
      - main
env:
  AWS_REGION: ap-northeast-1
  REPOSITORY_NAME: {{ リポジトリ名が入ります }}
# permission can be added at job level or workflow level    
permissions:
  id-token: write   # This is required for requesting the JWT
  contents: read    # This is required for actions/checkout
jobs:
  MirrortoCodeCommit:
    runs-on: ubuntu-latest
    steps:
      - name: Git clone the repository
        uses: actions/checkout@v3
        with:
          fetch-depth: 0 
      - name: Configure aws
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.IAM_ROLE_ARN }} 
          role-session-name: {{ IAM Role名 }}
          aws-region: ${{ env.AWS_REGION }}
      - name: PushtoCodeCommit 
        run: |
          git config --global credential.helper '!aws codecommit credential-helper $@'
          git config --global credential.UseHttpPath true
          git remote add codecommit https://git-codecommit.${{ env.AWS_REGION }}.amazonaws.com/v1/repos/${{ env.REPOSITORY_NAME }}
          git push --mirror codecommit

私自身、GitHub Actionsを使用する機会が少ないので書く項目で何をしているのかざっくりまとめてみたいと思います。
興味のある方はご覧ください。

name

ワークフローの名前

on

GitHub Actionsを実行するトリガーを指定できます。
今回しているのはpushなので、pushされたタイミングでGitHub Actionsのワークフローが実行されます。

プルリクエストがマージされた時のイベントでトリガーしたかったのですが、マージに関するイベント指定はできないようでした。
そのため、今回はmain(masterなど) ブランチに直接pushしないルールがある場合を前提として、mainにpushが走ったものをトリガーにしました。

マージしたタイミングでも、mainブランチに対してpushイベントが発生するのでpushイベントとブランチを指定しているという定義になります。
jobsでプルリクエストがマージされたら、というif文を書くこともできるのですが、ジョブを実行せずともGitHub Actionsが動いてしまいます。
実行ログの視認性という観点では望ましくないと感じました。

pushだけでなく、forkやdelete,createなど、非常に多くのアクションをトリガーを指定できるので、詳細はGitHub Actionsのドキュメントをご覧ください。

docs.github.com