Chrome拡張機能をリリース時に自動でChrome Web Storeに公開する

はじめに

Chrome拡張機能のリリース作業は地味に手間がかかります。zipファイルを作って、Chrome Web Store Developer Dashboardを開いて、アップロードして、公開ボタンを押す。1回あたり数分の作業ですが、複数の拡張機能を管理していると、リリースのたびにこの手順を繰り返すのがじわじわとストレスになります。

この記事では release-please と GitHub Actions を組み合わせた自動公開の仕組みを紹介します。Conventional Commitsでコミットし、Release PRをマージするだけでChrome Web Storeへの公開まで完了します。一度設定すれば、手動でのアップロード作業はなくなります。

この記事でわかること。
– Chrome Web Store APIのOAuth認証情報の取得手順
– release-pleaseで`manifest.json`のバージョンも自動更新する設定
– GitHub Actionsでリリース→自動公開を実現するワークフロー
– ハマりやすいポイント（バージョン不一致、権限設定、審査中の挙動）

なぜrelease-pleaseなのか

リリース自動化ツールにはsemantic-releaseという選択肢もありますが、今回はrelease-pleaseを採用しました。

semantic-releaseはマージ即リリースですが、release-pleaseはRelease PRを挟むため、CHANGELOGやバージョン番号を確認してからリリースできる
Google製なのでChrome Web Store APIとの相性がよく、同じエコシステムで統一できる
extra-filesでmanifest.jsonのバージョンも一緒に更新でき、Chrome拡張特有のバージョン管理に対応しやすい

全体の流れ

graph LR
    A[fix: commit] --> B[release-please]
    B --> C[Release PR作成]
    C --> D[PRマージ]
    D --> E[リリース作成]
    E --> F[Chrome Web Store公開]

fix: や feat: プレフィックス付きでコミット
release-pleaseがRelease PRを自動作成
Release PRをマージするとリリースが作成される
リリース作成をトリガーにChrome Web Storeへ自動アップロード

事前準備

Google Cloud ConsoleでOAuth認証情報を取得

Chrome Web Store APIを使うには、OAuth 2.0の認証情報が必要です。

Google Cloud Consoleにアクセス
プロジェクトを作成（または既存のものを選択）
「APIとサービス」→「ライブラリ」から Chrome Web Store API を有効化
「APIとサービス」→「認証情報」→「認証情報を作成」→「OAuthクライアントID」
アプリケーションの種類は「デスクトップアプリ」を選択
作成後、クライアントID と クライアントシークレット をメモ

リフレッシュトークンの取得

リフレッシュトークンは手動で取得します。

# 変数を設定
CLIENT_ID="your-client-id"
CLIENT_SECRET="your-client-secret"

# 認証URLを開く（macOS）
open "https://accounts.google.com/o/oauth2/auth?response_type=code&scope=https://www.googleapis.com/auth/chromewebstore&client_id=${CLIENT_ID}&redirect_uri=urn:ietf:wg:oauth:2.0:oob"

ブラウザで認証後、表示される認証コードを使ってリフレッシュトークンを取得します。

AUTH_CODE="ブラウザに表示された認証コード"

curl -s -X POST https://oauth2.googleapis.com/token 
  -d "client_id=${CLIENT_ID}" 
  -d "client_secret=${CLIENT_SECRET}" 
  -d "code=${AUTH_CODE}" 
  -d "grant_type=authorization_code" 
  -d "redirect_uri=urn:ietf:wg:oauth:2.0:oob"

レスポンスの refresh_token を保存します。

OAuth同意画面の「テストユーザー」に自分を追加しないと403エラーになります。

GitHub Secretsの設定

リポジトリの Settings → Secrets and variables → Actions で以下を設定します。

Secret名	値
`CHROME_EXTENSION_ID`	拡張機能のID
`CHROME_CLIENT_ID`	OAuthクライアントID
`CHROME_CLIENT_SECRET`	OAuthクライアントシークレット
`CHROME_REFRESH_TOKEN`	取得したリフレッシュトークン

拡張機能IDの確認方法

Chrome Web Store Developer Dashboardで拡張機能を選択し、URLの末尾にあるIDをコピーします。
`https://chrome.google.com/webstore/detail/[EXTENSION_ID]`

CHROME_CLIENT_ID、CHROME_CLIENT_SECRET、CHROME_REFRESH_TOKEN は複数のリポジトリで共通利用できます。CHROME_EXTENSION_ID だけは拡張機能ごとに異なります。

リポジトリの権限設定

Settings → Actions → General で以下を設定します。

Workflow permissionsを「Read and write permissions」に変更
「Allow GitHub Actions to create and approve pull requests」にチェック

ワークフローの設定

release-please-config.json

manifest.json のバージョンも自動更新するため、extra-files を設定します。

{
  "packages": {
    ".": {
      "release-type": "node",
      "bump-minor-pre-major": true,
      "bump-patch-for-minor-pre-major": true,
      "extra-files": [
        {
          "type": "json",
          "path": "manifest.json",
          "jsonpath": "$.version"
        }
      ]
    }
  },
  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}

この設定がないと `package.json` と `manifest.json` のバージョンがずれます。その結果、Chrome Web Storeへのアップロードが「Invalid version number in manifest」エラーで失敗します。

.GitHub/workflows/release-please.yml

name: Release Please

on:
  push:
    branches: [main]

permissions:
  contents: write
  pull-requests: write

jobs:
  release-please:
    runs-on: ubuntu-latest
    outputs:
      release_created: ${{ steps.release.outputs.release_created }}
      tag_name: ${{ steps.release.outputs.tag_name }}
    steps:
      - uses: googleapis/release-please-action@v4
        id: release
        with:
          release-type: node

  publish-to-chrome-web-store:
    needs: release-please
    if: ${{ needs.release-please.outputs.release_created }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Create zip file
        run: |
          zip -r extension.zip . 
            -x "*.git*" 
            -x "node_modules/*" 
            -x "*.md" 
            -x "package*.json" 
            -x ".github/*" 
            -x "tests/*"

      - name: Upload to Chrome Web Store
        uses: mnao305/chrome-extension-upload@v5.0.0
        with:
          file-path: extension.zip
          extension-id: ${{ secrets.CHROME_EXTENSION_ID }}
          client-id: ${{ secrets.CHROME_CLIENT_ID }}
          client-secret: ${{ secrets.CHROME_CLIENT_SECRET }}
          refresh-token: ${{ secrets.CHROME_REFRESH_TOKEN }}
          publish: true

release-please ジョブの outputs でリリース作成を検知します。publish-to-chrome-web-store ジョブは release_created が true の時だけ実行されます。zip作成時には .git、node_modules、ドキュメント類を除外しています。

手動公開用ワークフロー（オプション）

緊急時の手動公開用に workflow_dispatch も用意しておくと便利です。

name: Publish to Chrome Web Store

on:
  workflow_dispatch:

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Create zip file
        run: |
          zip -r extension.zip . 
            -x "*.git*" 
            -x "node_modules/*" 
            -x "*.md" 
            -x "package*.json" 
            -x ".github/*"

      - name: Upload to Chrome Web Store
        uses: mnao305/chrome-extension-upload@v5.0.0
        with:
          file-path: extension.zip
          extension-id: ${{ secrets.CHROME_EXTENSION_ID }}
          client-id: ${{ secrets.CHROME_CLIENT_ID }}
          client-secret: ${{ secrets.CHROME_CLIENT_SECRET }}
          refresh-token: ${{ secrets.CHROME_REFRESH_TOKEN }}
          publish: true

よくあるエラーと対処法

Invalid version number in manifest

package.json と manifest.json のバージョンが一致していない場合に発生。

対処法: release-please-config.json に extra-files を追加して manifest.json も自動更新されるようにする。

GitHub Actions is not permitted to create or approve pull requests

リポジトリの権限設定が不足しています。

対処法: Settings → Actions → General で「Allow GitHub Actions to create and approve pull requests」を有効にする。

403 access_denied

OAuth同意画面でテストユーザーに追加されていない。

対処法: Google Cloud Console → OAuth同意画面 → テストユーザーに自分のメールアドレスを追加。

審査中に新バージョンをアップロードした場合

Chrome Web Storeで審査中のバージョンがある状態で新しいバージョンをアップロードすると、審査中のバージョンは自動的にキャンセルされ、新しいバージョンが審査キューに入ります。

頻繁にリリースすると審査がいつまでも終わらない状態になりえます。ある程度変更をまとめてからリリースするのがおすすめです。

おわりに

この仕組みを導入してから、Chrome拡張機能のリリース作業が格段に楽になりました。Conventional Commitsでコミットして、Release PRをマージするだけで公開まで完了します。

複数のChrome拡張機能を管理している場合は、OAuth認証情報を共通で使えるので、最初の設定さえ済めば2つ目以降は CHROME_EXTENSION_ID を設定するだけです。

実際にこの仕組みで自動公開しているChrome拡張機能もあるので、よければ使ってみてください。

Chrome拡張の開発記事をほかにも書いています。

参考リンク

chrome-extension-upload – 使用したGitHub Action
release-please – Google製のリリース自動化ツール
Chrome Web Store API – 公式ドキュメント