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

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

    はじめに

    GAS開発において、ブラウザ上のGASスクリプトエディタでコードを編集すると、変更履歴の管理やチームでの共同作業が難しくなります。

    以前、Windows11環境でclaspを使ってVS Code上でGASを開発する方法をまとめました。

    ローカル環境でGAS開発ができるようになると、次に課題になるのが「コードを修正するたびに clasp push を手動で実行する手間」です。
    この手間を、GitHub Actionsと組み合わせることで解消できます。

    今回は、claspとGitHub Actionsを連携させ、GitHubへPushするだけでGASへ自動デプロイされる環境の構築手順についてまとめます。

    動作環境

    • OS: Windows11

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

    前提条件

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

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

      • GitHubアカウント

    claspの導入やGASプロジェクトのローカルへのクローンの方法については、それぞれ以下の記事を参考にしてください。

    構築の流れ(3ステップ)

    1. GitHubリポジトリの作成とローカル環境のコードの準備

    2. GitHub Actionsに認証情報(Secret)を設定

    3. ワークフローファイル(deploy.yml)の作成・Push

    手順1: GitHubリポジトリの作成と準備

    ローカル環境のGASプロジェクトをGitHubで管理するためのリポジトリを作成します。

    お使いの環境にあわせて、以下の2つのパターンから選択してください。

    • パターンA(GitHub CLI(gh)を使用): 1回のコマンド実行で、リポジトリ作成からPushまでを一括実行する場合

    • パターンB(GitHubブラウザ画面+Gitコマンドを使用): ブラウザ画面でリポジトリを作成し、手動でPushする場合

    パターンA: GitHub CLI(gh)を使用する場合

    ※このパターンを行うには、GitHub CLI(gh)のインストールと認証が必要です。

    GASプロジェクトのあるディレクトリに移動し、PowerShellを起動します。そして、以下のコマンドを実行します。

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

    # カレントディレクトリからGitHubリポジトリを作成してPushまで一括実行
    gh repo create [リポジトリ名] --private --source=. --remote=origin --push

    このコマンドにより、カレントディレクトリからリポジトリの作成と初期Pushを1つのコマンドで実行完了できます。公開リポジトリにする場合は、--private を --public に変更します。

    パターンB: GitHubブラウザ画面+Gitコマンドを使用する場合

    1.GitHubで新しいリポジトリを作成

    GitHubにアクセスし、「New repository」から新しいリポジトリを作成します。

    画像
    GitHubで新しいリポジトリ作成

    リポジトリ名を設定し、「Create repository」を実行します。

    画像
    リポジトリ名設定画面


    2.ローカル環境で初期化とPush

    GASプロジェクトのあるディレクトリでPowerShellを起動します。
    そして、以下のコマンドを実行してコードをGitHubにPushします。

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

    # Gitリポジトリの初期化
    git init
    
    # デフォルトブランチをmainに設定
    git branch -M main
    
    # リモートリポジトリの追加
    git remote add origin https://github.com/<ユーザー名>/<リポジトリ名>.git
    
    # ファイルのステージングとコミット
    git add .
    git commit -m "feat: initial commit"
    
    # GitHubへのPush
    git push -u origin main

    注意点
    claspのログイン認証情報が含まれる .clasprc.json などの機密ファイルを誤ってGitHubにコミットしないように、あらかじめ .gitignore ファイルを作成し、除外設定を記述しておきます。

    手順2: 認証情報をGitHub Secretsに登録する

    GitHub ActionsからGASへデプロイを行うには、claspの認証情報が必要になります。

    1.認証情報のコピー

    ローカルPCのユーザーディレクトリにある認証ファイルを開いて内容をコピーします。

    C:\\Users\\[ユーザー名]\\.clasprc.json

    2.GitHub Secretsへ登録

    対象のGitHubリポジトリ画面を開き、「Settings」>「Secrets and variables」>「Actions」の順に進みます。

    画像
    GitHub Actions Settings画面

    Actions secrets and variables画面で、「New repository secret」ボタンをクリックします。

    画像
    New repository secretボタン

    以下の内容を入力して、「Add secret」ボタンをクリックし、設定内容を保存します。

    画像
    Secret登録画面


    • Name: CLASPRC_JSON

    • Secret: 先ほどコピーした .clasprc.json のテキスト全文を貼り付け

    手順3: ワークフローファイルの作成とデプロイ設定

    GitHub Actionsで自動デプロイ(clasp push)を実行するための定義ファイル(YAML形式)を作成します。

    1.ディレクトリとファイルの作成

    GASプロジェクトのルートディレクトリに .github/workflows ディレクトリを作成します。
    そのディレクトリ内に deploy.yml というファイルを作成します。

    2.deploy.yml の記述

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

    name: Deploy to GAS
    
    on:
      push:
        branches:
          - main
    
    jobs:
      deploy:
        runs-on: ubuntu-latest
        steps:
          - name: Checkout code
            uses: actions/checkout@v4
    
          - name: Setup Node.js
            uses: actions/setup-node@v4
            with:
              node-version: '20'
    
          - name: Install clasp
            run: npm install -g @google/clasp
    
          - name: Create .clasprc.json
            run: echo "${{ secrets.CLASPRC_JSON }}" > ~/.clasprc.json
    
          - name: Deploy to GAS
            run: clasp push --force

    順番に、deploy.ymlの処理の内容を説明します。

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

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

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

    4. echo "${{ secrets.CLASPRC_JSON }}" > ~/.clasprc.json で、Secretsに登録した認証情報を .clasprc.json として書き出します。

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

    6. コミット、Push

    記述完了したら、deploy.yml をGitにコミットし、GitHubにPushします。

    動作確認

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

    1.GitHubリポジトリの「Actions」タブを開きます。

    画像
    Actionsタブ

    2.実行されたDeploy to GASワークフローを選択し、すべてのステップに緑色のチェックマーク(成功)がついているか確認します。

    画像
    ワークフロー画面

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

    まとめ

    今回は、claspとGitHub Actionsを連携させて、GASへの自動デプロイ環境を構築する手順について解説しました。

    この設定を一度行っておけば、次回からはローカルでコードを修正してPushすると、安全かつ自動的にデプロイが完了します。
    ぜひご自身のGAS開発環境に取り入れてみてください。

    参考サイト


    連載目次

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

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

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

    あなたへのおすすめ