Github Actionsで別のリポジトリをcheckoutする

公開日時

Github Actionsでtestを実行する際に、API仕様書からモックサーバを立ち上げたかったのだが、API仕様書自体は別のprivateリポジトリで管理していたためActionの実行時にcheckoutする必要があった。

actions/checkoutのREADMEにあるように、repositoryとpathを指定すれば別のリポジトリをpath以下にcheckoutできる。

privateリポジトリの場合はこれらに加えて、Personal Access Tokenを取得してリポジトリのSecretsに登録する必要があった。

yamlはこんな感じ。

      - name: yarn
        run: |
          yarn
      - name: Checkout doc repo
        uses: actions/checkout@v2
        with:
          repository: xxxx/some_api_doc
          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
          path: doc
      - name: Run test
        run: |
          yarn run test

Related #github

Github ActionでfirebaseプロジェクトをS3にデプロイする

deploymentブランチにpushしたら自動でs3にデプロイできるようになった

Github ActionでCloudfrontのキャッシュをクリアする

デプロイ後にキャッシュクリアを行うように設定

Github Actionで自動コミット設定をする

pushするとAPI仕様書の自動更新ができるようになる

Github Actionで特定のブランチの場合のみ実行する処理を書く

if: contains(github.ref, 'master')でmasterのみ自動コミットをするようにした