GitHub Actionsでビルドしたファイルをリリースノートに格納する
背景
最近、友人と自分用にGoogle Chromeの拡張機能を開発しています。
大々的に公開するわけではないので、manifest.jsonを含めたファイルをそれぞれのPCに手動で配置して動かしています。
しかし、友人たちはエンジニアではないので、アップデート作業ができるだけ簡単に行えるようにしたいと考えました。
拡張機能自体は、Vite + TypeScriptで構築しています。前に記事で紹介したように、非エンジニア向けに手間をかけず、更新後は簡単に拡張機能をアップデートできる仕組みが必要でした。
実装の流れ
自動化のフローは以下のような感じです。
-
mainブランチに変更をマージ - GitHub Actionsで自動的にファイルをビルドし、Zip圧縮
- リリースノートに圧縮されたファイルをアップロード
- 利用者がリリースノートからダウンロードし解凍
- 解凍したファイルを既存の拡張機能に上書きする
利用者はファイルをダウンロードしてコピペするだけで、最新の拡張機能にアップデートできます。
GitHub Actionsでの自動化設定
次に、GitHub Actionsを使って自動化する際の設定を紹介します。
GitHub Actionsでは、pull requestがmainブランチにマージされたタイミングでビルドと圧縮が自動で行われ、リリースノートにアップロードされる仕組みにしました。
以下はその例です。
name: Create Release Note
on:
pull_request:
# PRが閉じたタイミングで実行
types:
- closed
# mainブランチのみを対象とする
branches:
- main
jobs:
build-and-release:
permissions:
contents: write
pull-requests: write
# リリースブランチからマージのみ実施
if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'release')
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '20'
- uses: pnpm/action-setup@v4
with:
version: 9
- name: install dependencies
run: pnpm install --frozen-lockfile
- name: build dependencies
run: pnpm build
- name: Zip the dist directory
run: zip -r dist.zip dist
- name: Create Release and Upload Assets
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# PRのタイトルと内容をRELEASE_TAGに設定する
RELEASE_TAG: ${{ github.event.pull_request.title }}
uses: softprops/action-gh-release@v2
with:
files: dist.zip
tag_name: ${{ env.RELEASE_TAG }}
name: Release ${{ env.RELEASE_TAG }}
draft: false
prerelease: false
課題と改善点
実装はうまくいったものの、問題もありました。
リリースノートにアップロードしたdist.zipをダウンロードしようとすると、ウイルスとして検出されてしまい、ダウンロードができないという状況に直面しました😭
セキュリティを落とさずに対応できる方法を調べ、zip-releaseというアクションを使うことで改善しました。
修正したところ、無事Release Noteにファイルを添付することができました。
name: Create Release Note
on:
pull_request:
# PRが閉じたタイミングで実行
types:
- closed
# mainブランチのみを対象とする
branches:
- main
jobs:
build-and-release:
permissions:
contents: write
pull-requests: write
# リリースブランチからマージのみ実施
if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'release')
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '20'
- uses: pnpm/action-setup@v4
with:
version: 9
- name: install dependencies
run: pnpm install --frozen-lockfile
- name: build dependencies
run: pnpm build
# ZIPファイルを作成する（distディレクトリを対象）
- name: Archive Release
uses: thedoctor0/zip-release@main
with:
type: 'zip'
filename: extensions.zip
# distディレクトリにZIPファイルを作成
directory: dist
# リリースを作成し、生成されたZIPファイルをアップロードする
- name: Create Release and Upload Assets
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# PRのタイトルと内容をRELEASE_TAGに設定する
RELEASE_TAG: ${{ github.event.pull_request.title }}
uses: softprops/action-gh-release@v2
with:
# dist内のZIPファイルを指定
files: dist/extensions.zip
tag_name: ${{ env.RELEASE_TAG }}
name: ${{ env.RELEASE_TAG }}
draft: false
prerelease: false
最後に
最終的には、GitHub Actionsを活用した自動更新フローを構築できました。
これで、エンジニアでない友人たちも手軽に最新バージョンを使い続けることができるようになり、非常に便利になったと感じています。
技術的な部分も少しずつ改善しながら、今後もさらに使いやすい形にしていきたいと思います。
参考
Discussion