メインコンテンツへスキップ
見出し画像

[GAS] clasp × GitHub Actionsの自動デプロイを効率的に運用する方法 - 2. Reusable Workflow編

    はじめに

    前回は、claspとGitHub Actionsを連携させて、GASを自動デプロイする環境の構築方法についてまとめました。

    今回は、GASプロジェクトを複数管理するようになったときに直面する運用の手間と、その解消方法についてまとめます。

    プロジェクトが増えると発生する運用の手間

    前回の手順を複数のGASプロジェクトへそのまま適用すると、リポジトリを新しく作るたびに、以下の2つの作業が毎回発生します。

    • リポジトリごとに CLASPRC_JSON をSecretsへ登録し直す

    • deploy.yml を新しいリポジトリへコピペする

    プロジェクトが少ないうちは問題になりませんが、プロジェクトが増えるほど「あのリポジトリはSecrets登録してなかった」「deploy.ymlの内容がリポジトリごとに微妙にずれている」といった作業の漏れにつながります。

    動作環境・前提条件

    • OS: Windows11

    • 開発環境: VS Code、Git、Node.js(npm)

    • 必要ツール・アカウント:

      • clasp(インストールおよび clasp login による認証が完了していること)

      • GitHubアカウント

    解決の方針

    解決方法として、下記の2つの方法が考えられます。

    1. GitHub Organizationを作成し、「Organization Secrets」で認証情報を一元管理する方法

    2. Reusable Workflow(再利用可能なワークフロー)を使い、デプロイ処理そのものを1つの共通リポジトリにまとめる方法

    1つ目の方法で使用する、GitHub Organizationとは、複数のリポジトリやメンバーをまとめて管理する、個人アカウントとは別枠の組織単位です。
    GitHub Organizationの「Organization Secrets」機能を使用すれば、そのOrganization配下のリポジトリ全体で認証情報を一元管理できます。
    ただし、この方法だと個人のGitHubアカウントとは別に、GitHub Organizationを新しく作成・管理する必要があり、今使っている個人アカウントのままでは完結しないため、今回は見送りました。

    今回は、個人アカウントのままでも導入できる2つ目の方法、Reusable Workflowを採用しました。

    構成のイメージ

    全体の構成は、下記です。

    your-account/gas-deploy-workflow/    ← 共通ワークフロー置き場(新規リポジトリ)
    └── .github/workflows/
        └── deploy.yml                  ← workflow_callを持つ実処理本体
    
    your-account/project-a/              ← 個別のGASプロジェクトリポジトリ
    └── .github/workflows/
        └── deploy.yml                  ← 数行の呼び出し側のみ

    デプロイ処理の本体は、共通ワークフロー用リポジトリである gas-deploy-workflow リポジトリに1つだけ置き、各GASプロジェクトのリポジトリ側は、その本体を呼び出す数行のファイルだけを持つ構成にします。

    画像
    ディレクトリ構成のイメージ

    手順1: 共通ワークフロー用リポジトリを作成する

    gas-deploy-workflow のような名前で、GitHub上に新規リポジトリを作成します。
    Public/Privateどちらでも作成可能ですが、今回はPrivateで作成しました。
    Privateで作成する場合、手順3の追加設定が必要になります。

    手順2: 共通ワークフロー本体を作成する

    作成した共通ワークフロー用リポジトリ gas-deploy-workflow リポジトリに .github/workflows/deploy.yml を作成します。

    全体の処理は、下記です。

    name: GAS Deploy (reusable)
    
    on:
      workflow_call: {}
    
    jobs:
      deploy:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v4
          - uses: actions/setup-node@v4
            with:
              node-version: '20'
          - run: npm install -g @google/clasp
          - name: Write credentials
            env:
              CLASPRC_JSON: ${{ secrets.CLASPRC_JSON }}
            run: echo "$CLASPRC_JSON" > ~/.clasprc.json
          - name: Push to GAS
            run: clasp push --force

    処理の内容を説明します。

    1. on.workflow_call を指定することで、このワークフローを他のワークフローから呼び出しすることができるようになります。

    2. actions/checkout@v4 で、呼び出し元リポジトリのコードをチェックアウトします。

    3. actions/setup-node@v4 で、Node.js(バージョン20)の実行環境をセットアップします。

    4. npm install -g @google/clasp で、claspをグローバルにインストールします。

    5. echo "$CLASPRC_JSON" > ~/.clasprc.json で、呼び出し元から渡されたSecretsを .clasprc.json として書き出します。

    6. clasp push --force で、GASプロジェクトへコードをデプロイします。

    処理の内容自体は、前回のワークフローとほぼ同じです。
    違いは、このファイル単体では動作せず、他のリポジトリから呼び出されて初めて実行される点になります。

    手順3: (Privateリポジトリの場合のみ)呼び出し許可を設定する

    共通ワークフロー用リポジトリである gas-deploy-workflow をPrivateリポジトリにした場合、他のリポジトリからこのワークフローを呼び出せるように、アクセス許可の設定が必要です。

    1.共通ワークフロー用リポジトリである `gas-deploy-workflow` リポジトリの「Settings」を開きます。

    2.左メニューの「Actions」>「General」を選択します。

    画像
    Actions設定画面

    3.一番下までスクロールし、「Access」セクションを表示します。

    4.「Accessible from repositories owned by the user '(あなたのユーザー名)'」(個人アカウントの場合)を選択し、「Save」をクリックします。

    画像
    Access設定の保存

    Publicリポジトリの場合は、この手順は不要です。

    手順4: 各プロジェクトリポジトリ側の呼び出しワークフローを作成する

    デプロイ対象となる、各GASプロジェクトのリポジトリに、共通ワークフローを呼び出すための deploy.yml を作成します。

    全体の処理は、下記です。

    name: Deploy to GAS
    
    on:
      push:
        branches: [main]
    
    jobs:
      deploy:
        uses: your-account/gas-deploy-workflow/.github/workflows/deploy.yml@main
        secrets: inherit

    順番に処理の内容を説明します。

    1. on.push.branches で、mainブランチへのPushをトリガーに設定します。

    2. jobs.deploy.uses で、手順2で作成した共通ワークフローを、リポジトリ名とブランチ参照(@main)で指定します。

    3. secrets: inherit で、呼び出し元リポジトリに登録したSecrets(CLASPRC_JSON)を、呼び出し先の共通ワークフローへそのまま引き継ぎます。

    新規にGASプロジェクトのリポジトリを作る際は、このファイルをコピーして配置するだけです。

    手順5: Secretsを各プロジェクトリポジトリに登録する

    Reusable Workflow方式では、Secretsの一元管理はできないため、CLASPRC_JSON は前回同様、各プロジェクトリポジトリの「Settings」>「Secrets and variables」>「Actions」からリポジトリごとに登録します。

    登録手順は、前回の記事の手順2と同じとなりますので、下記の記事をご参照ください。

    Secrets登録の作業そのものはなくなりませんが、deploy.yml のコピペと保守が不要になる分、プロジェクトが増えたときの運用負荷は下がります。

    動作確認

    設定完了後、自動デプロイが動作するか確認します。

    1. 個別のGASプロジェクトリポジトリ(project-a 等)にコードをPushします。

    2. リポジトリの「Actions」タブを開き、deploy ジョブが gas-deploy-workflow 側の処理を呼び出して実行していることを確認します。

    3. GASのスクリプトエディタを開き、変更が自動的に反映されていることを確認します。

    まとめ

    今回は、GASプロジェクトが複数になった場合に、clasp × GitHub Actionsによる自動デプロイをReusable Workflowで効率的に運用する方法についてまとめました。

    デプロイ処理の本体を共通リポジトリに1つだけ持たせておくことで、新規プロジェクトを追加する際の作業を、数行の呼び出しファイルを配置するだけに減らすことができます。
    管理するプロジェクト数が増えてきた方は、ぜひ取り入れてみてください。

    参考リンク

    連載目次

    1. [GAS] clasp × GitHub Actionsで自動デプロイ環境を構築する方法 - 1. 基本編

    2. [GAS] clasp × GitHub Actionsの自動デプロイを効率的に運用する方法 - 2. Reusable Workflow編


     
     
    ノンプロ研にて、Python、GAS(Google Apps Script)、技術ライティング勉強中です。 東北地方の片隅で、オンラインアシスタントとして、リモートワークしています。

    あなたへのおすすめ