GitHub ActionsでCloud Functionsを自動デプロイする

GitHub Actionsを使い、masterにプッシュされたコードをCloud Functionsに自動デプロイするワークフローの構築メモです。

今回組んだワークフロー

yamlファイルの記述

name: Deploy Cloud Funcstions

on:
  workflow_dispatch:
  push:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
        
    - name: Set up Cloud SDK
      uses: google-github-actions/setup-gcloud@master
      with:
        project_id: my-project-id
        service_account_email: [e-mail]
        service_account_key: ${{ secrets.GCP_SA_KEY }}
        export_default_credentials: true

    - name: Deploy Functions
      run: sh app/deploy/deploy.sh

my-ci-account my-project-id あたりは自分の情報に置き換えてください。（以下に詳しく説明します）

解説

トリガー

on:
  workflow_dispatch:
  push:
    branches: [ master ]

masterブランチにプッシュされたとき、または手動（workflow_dispatch）でワークフローを実行する設定です。

チェックアウト

- uses: actions/checkout@v2

リポジトリをチェックアウト。
チェックアウトなどの基本的な処理はActionsが提供してくれています。（ここにリンク）

Cloud SDKのセットアップ

 - name: Set up Cloud SDK
      uses: google-github-actions/setup-gcloud@master
      with:
        project_id: my-project-id
        service_account_email: [e-mail]
        service_account_key: ${{ secrets.GCP_SA_KEY }}
        export_default_credentials: true

GCPへの認証です。
Googleが提供している setup-gcloud を使って、READMEに従って設定していきます。

以下の情報が必要なので、準備していきます。

• プロジェクトID
• サービスアカウントの情報（メールアドレスと鍵）

サービスアカウントというのはGCPのIAMで作成できるアカウントで、通常のアカウントとは違ってCIなどのマシン上で使われるアカウントです。

ひとつずつ準備していきます。

プロジェクトIDの確認

gcloud projects list

で自分のプロジェクトの一覧が出力されます。該当のプロジェクトIDをチェックします。

サービスアカウントの作成

gcloud iam service-accounts create my-ci-account \
--description="GitHubAction" \
--display-name="My CI ACCOUNT"

公式ドキュメントはこちら

サービスアカウントに権限を付与

作成したサービスアカウントに権限を紐付けます。

1.Cloud Functsionsの権限

gcloud projects add-iam-policy-binding my-project-id \
--member="serviceAccount:[e-mail]" \
--role="roles/cloudfunctions.developer"

2.appspotのアカウントとサービスアカウントの権限

gcloud iam service-accounts add-iam-policy-binding \
[e-mail] \
--member='serviceAccount:[e-mail]' \
--role=roles/iam.serviceAccountUser

サービスアカウントの鍵情報を出力

続いて、認証のための鍵情報を出力します。

gcloud iam service-accounts keys create ~/key.json --iam-account [e-mail]

公式ドキュメントはこちら

出力した鍵情報をGitHubのSecretsに登録

出力されたJSONデータをGitHubのSecretsに登録します。
今回は GCP_SA_KEY のキー名で登録しました。

デプロイ

- name: Deploy Functions
  run: sh app/deploy/deploy.sh

Cloud Functionにデプロイします。
run に続けてデプロイのコマンドを直で書くこともできますが、今回は複数デプロイが必要なのでシェルスクリプトにまとめました。

シェルスクリプトの中身はこちら：

gcloud functions deploy FUNCTION_NAME_1 \
--runtime python38 \
--timeout 540 \
--source app \
--trigger-topic TOPIC_NAME_1 \

gcloud functions deploy FUNCTION_NAME_2 \
--runtime python38 \
--timeout 540 \
--source app \
--trigger-topic TOPIC_NAME_2 \

gcloud functions deploy FUNCTION_NAME_3 \
--runtime python38 \
--timeout 540 \
--source app \
--trigger-topic TOPIC_NAME_3 \

また、Googleが公式に提供している google-github-actionsを利用することもできます。
その場合は以下のREADMEを参考に設定します。
https://github.com/google-github-actions/deploy-cloud-functions

以上の設定でワークフロー構築は完了です。

ダッシュボード上での表示

GitHub Actionsの見た目

GitHubのActionsタブを開くとワークフローの画面が開きます。
ビルド履歴やエラーが起きた際のログはここで確認できます。

手動実行は「Run Workflow」から

workflow_dispatchをトリガーに追加していたので手動でここから実行できるようになっています。

まとめ

GitHub Actionsを利用して、自動デプロイの仕組みを作りました。
GCPに慣れていないため権限まわりに少し時間がかかりましたが、提供されているactionも揃っておりスムーズに構築ができました。

これから設定される方のお役に立てれば幸いです。