GitHub Custom Actionのレシピ

Transcript

1. 0 GitHub Custom Actionのレシピ 2025-04-04 第119回NearMe技術勉強会 @yujiosaka
2. 1 第103回のまとめ：GitHub Custom Actionを公開した https://github.com/marketplace/actions/adr-sync
3. 2 GitHub Custom Actionとは？ • パッケージをインストールしなくても、GitHub Actionsのstepsに 数⾏追加するだけでどのレポジトリからでも実⾏できる • withを⽤いて設定できる こういうやつ
4. 3 実態はただのGitHubレポジトリ https://github.com/actions/checkout
5. 4 ADR Syncの設定 steps: - name: Run ADR Sync Action uses: yujiosaka/adr-sync@v1 with: github-token: ${{ secrets.GH_TOKEN }}
6. 5 GitHub Custom Actionに必要最低限の設定 action.yml name: "ADR Sync" description: "A GitHub custom action to synchronize ADRs with GitHub Discussions" author: "Yuji Isobe" inputs: ... github-token: description: "GitHub token with necessary permissions to synchronize ADRs" required: true runs: using: "node20" main: "dist/index.js" Marketplaceのリスティングとオートコンプリートで使⽤される
7. 6 GitHub Custom Actionに必要最低限の設定 action.yml name: "ADR Sync" description: "A GitHub custom action to synchronize ADRs with GitHub Discussions" author: "Yuji Isobe" inputs: ... github-token: description: "GitHub token with necessary permissions to synchronize ADRs" required: true runs: using: "node20" main: "dist/index.js" withで指定できる設定
8. 7 GitHub Custom Actionに必要最低限の設定 action.yml name: "ADR Sync" description: "A GitHub custom action to synchronize ADRs with GitHub Discussions" author: "Yuji Isobe" inputs: ... github-token: description: "GitHub token with necessary permissions to synchronize ADRs" required: true runs: using: "node20" main: "dist/index.js" 今のところnode12、node16、node20、 docker、compositeしか指定できない
9. 8 GitHub Custom Actionに必要最低限の設定 action.yml name: "ADR Sync" description: "A GitHub custom action to synchronize ADRs with GitHub Discussions" author: "Yuji Isobe" inputs: ... github-token: description: "GitHub token with necessary permissions to synchronize ADRs" required: true runs: using: "node20" main: "dist/index.js" 実⾏するファイル
10. 9 nodeを使⽤する時に便利なパッケージ • @actions/core: withで指定した設定を受け取ったり、アウトプットを定義できる • @actions/github: コンテキスト（イベント名やコミットハッシュ等）を受け取れる import * as core from "@actions/core"; import * as github from "@actions/github"; const context = github.context; const arg1 = core.getInput("arg1"); console.log(`This event is triggered by ${context.eventName} with arg1: ${arg1}`);
11. 10 dockerを使⽤する例 action.yml name: 'Hello World' description: 'Greet someone and record the time' inputs: who-to-greet: description: 'Who to greet' required: true runs: using: 'docker' image: 'yujiosaka/hello-world' args: - ${{ inputs.who-to-greet }} entrypointに渡す引数
12. 11 dockerを使⽤する例 Dockerfile FROM alpine:3.10 COPY entrypoint.sh /entrypoint.sh ENTRYPOINT ["/entrypoint.sh"]
13. 12 dockerを使⽤する例 entrypoint.sh #!/bin/sh -l echo "Hello $1" time=$(date) echo "time=$time" >> $GITHUB_OUTPUT action.ymlで渡された引数
14. 13 name: 'Hello World' description: 'Greet someone' inputs: who-to-greet: description: 'Who to greet' required: true runs: using: "composite" steps: - name: Set Greeting run: echo "Hello $INPUT_WHO_TO_GREET." shell: bash env: INPUT_WHO_TO_GREET: ${{ inputs.who-to-greet }} compositeを使⽤する例 通常のactionsと同様に stepsを定義するだけ （shellスクリプトだけで  いい時に便利）
15. 14 注意点 Linux MacOS Windows Docker ◯ × × JavaScript ◯ ◯ ◯ Composite △ △ △ Runnerの環境ごとにstepを書き分けなければいけない
16. 15 JavaScriptがおすすめ 15
17. 16 Marketplaceに公開する⼿順 16
18. 17 （GitHub Releaseを作成するために）タグをPushする 個⼈的にはsemantic-releaseがおすすめ（余談） $ git tag v1.0.0 $ git push origin v1.0.0 https://github.com/semantic-release/semantic-release
19. 18 GitHub Releaseを作成するときにチェックを⼊れるだけ
20. 19 あとは恨み節 19
21. 20 Bun/Deno使わせてよ‧‧‧ • Runnerの環境に依存させないために、他のパッケージやバイナリに依存させられない • npm installやビルドを⾛らせることができないので、ビルド済みのファイルをコミッ トしないといけない • せめてBun/Denoが使えたらTypeScriptを直接実⾏できるのに（Node22から型情報を 無視して実⾏できるオプションが加わるからそれ待ちか？）
22. 21 actions/coreとactions/githubは使えるようにしといてよ‧‧‧ • actions/coreとactions/githubはGitHub Custom Actionを作成するのにほぼ必須だが、 初めから使えるようになっているわけではないので、npm installしないといけない • でも、GitHub Custom Action実⾏時にnpm installが⾛るわけではないので、 node_modulesごとコミットするか（やりたくない）、パッケージも含めてビルドし て、ビルド後のファイルをコミットしないといけない （当然）こっちにした
23. 22 { "name": "adr-sync", "version": "1.0.0", "description": "A GitHub custom action to synchronize ADRs with GitHub Discussions.", "type": "module", "scripts": { "build": "ncc build src/index.ts --minify", "check": "biome check .", "check:write": "biome check --write .", "prepare": "husky", "test": "vitest run", "test:watch": "vitest" }, ... } package.json TypeScriptのコンパイル、 パッケージのバンドル、 圧縮して、dist/index.jsを作成 （dist/index.jsもコミット必要）
24. 23 Thank you