Funmary のリポジトリ (組織 funmary-app) で、PR の作者に、ライセンスへの同意を求める Cloudflare Worker です。
- だれかが PR を開く (または push する) と、GitHub App の Webhook が届く
- そのリポジトリでの同意の記録がなければ、PR に案内のコメント (同意のページへのリンク) を送り、検査「ライセンスへの同意」を「待ち」にする
- 作者が同意のページで GitHub にログインし、「同意する」を押すと、D1 に記録し、その人がそのリポジトリで開いている PR の検査を通す。そのあと、案内のコメントがあった PR のページに戻す
- 同意はリポジトリごとに 1 回です。同じ人でも、別のリポジトリでは、もう一度同意を求めます
- リポジトリの持ち主や組織のメンバーにも、ほかの人と同じく同意を求めます。求めないのは、Bot (Renovate など) の PR だけです
- 記録は、リポジトリと人の ID で持ちます。リポジトリの名前を変えたり、移管したりしても、記録は切れません
- 受け付けるのは、
wrangler.jsoncのALLOWED_OWNERS(カンマ区切り。今はfunmary-app) の持ち主のリポジトリだけです。GitHub App は組織の外の人もログインできるように公開にするので、ほかの人が自分のリポジトリにインストールしても、そのリポジトリでは何もしません。fork して使うときは、自分の持ち主に替えます
各リポジトリの既定のブランチの .github/license-agreement.md を、そのまま同意のページに出します (HTML としては解釈せず、ただの文字として出します)。
- このファイルの版 (Git の blob の SHA) を、同意の版として記録します。文面を変えると、前の版に同意した人にも、もう一度同意を求めます
- ファイルがないリポジトリでは、GitHub が判定したそのリポジトリのライセンスへのリンクを出します。版は、ライセンスのファイルの SHA です
- そのリポジトリに
.github/license-agreement.mdを置く (書き方は、このリポジトリのものを参考にする) - GitHub App (下の「最初の準備」で作るもの) を、そのリポジトリにもインストールする
- そのリポジトリの ruleset の必須の検査に「ライセンスへの同意」を足す (送り元を、この GitHub App に限る)
App がまだ入っていないリポジトリの同意のページは、「受け付けていません」という 404 のページになります。
pnpm install
pnpm dev # 手元で動かす。秘密の値は .dev.vars (Git の管理対象外) に書く
pnpm format # 整形
pnpm typecheck # 型の検査
pnpm test # テスト
pnpm build:check # Cloudflare に送らずに、組み立てられるかを確かめるwrangler.jsonc を変えたら、pnpm types で worker-configuration.d.ts を作り直します。ブランチ、コミットメッセージ、PR の決まりは CONTRIBUTING.md にあります。
順番に行います。wrangler.jsonc の secrets.required にある秘密の値がそろうまで、Worker は反映できません。そのため、GitHub App を先に作り、秘密の値を置いてから反映します。
Worker の URL は https://license-agreement.<アカウントのサブドメイン>.workers.dev です。サブドメインは、Cloudflare のダッシュボードの Workers & Pages で確かめられます。反映の前から URL は決まっているので、1 の GitHub App の設定にそのまま使えます。
組織 funmary-app の Settings の Developer settings から、GitHub App を作ります。
| 項目 | 値 |
|---|---|
| Redirect URI | <Worker の URL>/callback |
| Request user authorization (OAuth) during installation | 外す |
| Webhook URL | <Worker の URL>/webhook |
| Webhook secret | 推測できない長い文字列 (openssl rand -hex 32 など) |
| Repository permissions | Contents: Read-only (同意の文面とライセンスを読む)、Pull requests: Read and write (PR に案内のコメントを書く)、Issues: Read and write、Commit statuses: Read and write (Metadata: Read-only は自動で付く) |
| Subscribe to events | Pull request |
| Where can this GitHub App be installed? | Any account (組織の外の人もログインできるように、公開にする。ほかの持ち主のリポジトリは ALLOWED_OWNERS で断る) |
作ったら、次を行います。
-
Client secret を作って控える。Client ID も控える
-
秘密鍵 (Private key) を作ってダウンロードする。GitHub が配る鍵は PKCS#1 の形なので、Worker で読める PKCS#8 の形に変換する
openssl pkcs8 -topk8 -nocrypt -in ダウンロードした鍵.pem -out key-pkcs8.pem
-
App を、対象のリポジトリ (
funmary-app/funmaryと、このリポジトリ) にインストールする
pnpm exec wrangler login でログインしてから、秘密の値を置きます。Worker がまだないときは、最初の wrangler secret put が「Worker を作るか」を聞くので、作ります (中身が空の Worker ができます)。
pnpm exec wrangler secret put GITHUB_APP_ID # App の ID (App の設定画面の上にある数字)
pnpm exec wrangler secret put GITHUB_APP_PRIVATE_KEY # key-pkcs8.pem の中身 (BEGIN PRIVATE KEY の行から END の行まで)
pnpm exec wrangler secret put GITHUB_WEBHOOK_SECRET # 1 の Webhook secret
pnpm exec wrangler secret put GITHUB_CLIENT_ID
pnpm exec wrangler secret put GITHUB_CLIENT_SECRET
pnpm exec wrangler secret put SIGNING_KEY # 推測できない長い文字列 (openssl rand -hex 32 など)6 つの値を 名前=値 の形で 1 つのファイル (Git の管理対象外の場所) に書いておけば、pnpm exec wrangler secret bulk <ファイル> でまとめて置けます。値を変えたときも、ファイルを直して同じコマンドを打てば足ります。
秘密鍵のファイル (key-pkcs8.pem とダウンロードした鍵) は、置いたら手元から消します。
6 つそろったら、pnpm run deploy で Worker と D1 のマイグレーションを反映します。
D1 は、初めての反映のときに Wrangler が作ります (wrangler.jsonc に database_id は書きません)。対話のできる端末で反映すると、Wrangler が wrangler.jsonc に database_id を書き足すことがありますが、コミットせずに戻して構いません。次からの反映も、同じ D1 につながります。fork して自分のアカウントで動かすときも、同じ手順で D1 ができます。
- Cloudflare で API トークンを作る (権限: Account の Workers Scripts: Edit と D1: Edit)。ダッシュボードの「API Tokens」の作成画面で、2 つの権限を付け、対象のアカウントを選ぶ。作ったトークンは、画面からコピーしてすぐ
gh secret set CLOUDFLARE_API_TOKEN --env productionで置く - このリポジトリの Settings で、環境
productionを作り、secret のCLOUDFLARE_API_TOKENとCLOUDFLARE_ACCOUNT_IDを置く。リポジトリの変数 (Variables) にDEPLOY_ENABLED(true) を置く。これで、main が変わるたびに反映される - 対象のリポジトリの ruleset の必須の検査に「ライセンスへの同意」を足す (送り元を、作った GitHub App に限る)。このリポジトリの必須の検査は、「検査とテスト」、「コミットメッセージの検査」、「秘密情報の混入検査」、「ライセンスへの同意」
- 別のアカウントで試しに PR を開き、案内のコメントと同意の流れを確かめる。リポジトリの持ち主やメンバーにも同意を求めるので、作者も各リポジトリで 1 回同意する
Cloudflare は Wrangler の後継の CLI「cf」をオープンベータで出しています。cf の安定版が出たら移します (Issue で管理する)。
BSD 3-Clause License (LICENSE-BSD-3-CLAUSE) と Apache License, Version 2.0 (LICENSE-APACHE) のデュアルライセンスです。このリポジトリでも、初めての PR のときにライセンスへの同意をお願いしています (CONTRIBUTING.md)。