リリースノート
ngx_mrubyの各リリースには、このディレクトリにvX.Y.Z.mdのファイルがあり、そのリリースで何が変わったかを書いています。ファイルの最初の節の「アップグレードの前に読む挙動の変更」には、同じnginx.conf、Rubyのスクリプト、ビルドが前のリリースと違う動きをする変更を、すべて挙げています。各変更について、変えた理由、影響を受ける人、必要な対応も書いています。アップグレードの前に、今動かしているバージョンより新しいすべてのファイルで、この節を読んでください。ファイルの隣のvX.Y.Z.ja.mdには、同じ内容を日本語で書いています。日本語版がまだ無いファイルには、そのファイルに追記するか、そのファイルを編集する次のプルリクエストが、日本語版を作ります。詳しくは「エントリーを書く人と時期」にあります。日本語版がまだ無いときは、英語版のvX.Y.Z.mdを読んでください。英語版が原文で、日本語版はその翻訳です。
v2.7.0までのリリースには、ここにファイルがありません。それらのリリースでは、GitHubのリリースのページに、マージしたプルリクエストの一覧があります。
オーナーは2026-10-04に、次のことを決めました。「アップグレードの前に読む挙動の変更」の各エントリーには、修正が挙動を変えなければならなかった理由も書きます。理由は、前の挙動を前提にして設定やスクリプトを作った読み手が納得できる形で書きます。また、リリースノートは、英語と日本語で正確に書きます。セッションは、下のテンプレートの「変更の理由」の行、日本語のファイル、GitHubのリリースの本文、タグの前のチェックで、この決定を実行します。
ブランチとサポート
Section titled “ブランチとサポート”v3.0.0でv3がmasterになるまで、masterには2.xの系列があり、nextにはv3の開発とそのプレリリースがあります。2.xを使い続けるときにどのブランチかタグからビルドすればよいかは、Branch strategyにあります。2.xは、v3.0.0の後12か月の間サポートします。サポートするのは、2.xの最新のリリースだけです。詳しくはサポートするバージョンにあります。
挙動の変更に数えるもの
Section titled “挙動の変更に数えるもの”挙動の変更とは、前のリリースとの違いのうち、設定、Rubyのスクリプト、ビルドから見えるもので、だれかがその挙動を前提にしていたかもしれないものです。次の一覧は例で、すべてではありません。そのような違いは、どれも挙動の変更として数えます。
- レスポンスのステータス、ヘッダ、ボディ
mruby_streamのハンドラが送るデータと、ハンドラが接続を閉じるタイミング- Rubyのメソッドが返す値と発生させる例外、どのクラスとメソッドがあるか
- どのハンドラが、どのフェーズで、どの順に動くか、その戻り値が何をするか
mruby_set、mruby_set_code、Nginx::Varが設定するnginxの変数の値。ほかのディレクティブやlog_formatが読む値ですnginx -tが設定を受け付けるかどうかと、ディレクティブの引数が持つ意味error.logの、レベルがnotice以上の行のうち、加わった行、無くなった行、別のレベルで出るようになった行。運用者が、これらの行でアラートを出すからです- ビルドの変更。ビルドの要件を上げること、nginxのstableの系列やプラットフォームのサポートをやめること、ビルドのオプションを消すか意味を変えること、同梱のmrubyか、デフォルトの
build_config.rbが入れるmrbgemsを変えることです。要件を上げる例は、OpenSSLの最低のバージョンを上げることです。サポートするnginxのバージョンは、下の「サポートするnginxのバージョン」にあります
既存のすべての設定、スクリプト、ビルドが前と同じに動く追加は、挙動の変更ではありません。たとえば、新しいディレクティブ、新しいRubyのクラスやメソッド、ディレクティブが受け付ける新しい値です。このような追加は「新機能」に書きます。ビルドの追加の変更は、「ビルドとテストの変更」に書きます。
オーナーは2026-10-29に「修正対象をしようとして使ってた場合に変更で変わる場合はノート必須」と述べました。「しようとして」は「仕様として」という意味です。セッションは、修正対象のコードを使う設定やスクリプトから違いが見えるなら、挙動の変更と扱います。たとえば、レスポンスのステータスやヘッダが変わる場合や、値を返していたメソッドや受け付けていた引数が例外になる場合です。従来の挙動自体が不具合でも、利用者がそれを前提に実装している可能性があるため、記録が必要です。例外は、クラッシュ、ハング、リークだけを解消し、設定やスクリプトから見えるものがほかに何も変わらない場合に限ります。一部の使い方でクラッシュを直す一方、別の使い方で例外や新しい結果が生じるなら、後者は挙動の変更です。迷ったときは、挙動の変更として記録してください。
「前のリリース」は、前のコミットではなく、最後のリリースのタグvX.Y.Zを指します。プレリリースのタグの-alpha.N、-beta.N、-rc.Nは、この意味のリリースではありません。そのため、v3.0.0.mdは、3.0.0を2.xの最新のリリースと比べます。2つのリリースの間で加わり、その後また変わった挙動は、一度もリリースしていません。2つ目を加えずに、そのエントリーを編集してください。
サポートするnginxのバージョン:ngx_mrubyは、README.mdにあるnginxのmainlineとstableの系列をサポートします。3.xでは1.30のstableと1.31のmainlineで、サポートする最も古いバージョンは毎年4月に上がります。ビルドの方法は、docs/install/の説明のとおりです。CIかnginx_versionで、新しいバージョンに置き換えられたmainlineのバージョンから新しいバージョンへ移っても、サポートするバージョンは減りません。これは「ビルドとテストの変更」に記録します。stableの系列のサポートをやめることと、プラットフォームのサポートをやめることは、挙動の変更です。stableの系列は、1.28のように、マイナーバージョンが偶数の系列です。
テスト、CI、ドキュメントだけの変更と、見える違いの無いリファクタリングには、「アップグレードの前に読む挙動の変更」のエントリーは要りません。コントリビューターやパッケージャーが知る必要のあるテストやCIの変更は、「ビルドとテストの変更」に書きます。たとえば、テストの新しいポートです。そのほかのテストやCIの変更、ドキュメントの変更、リファクタリングには、エントリーはまったく必要ありません。
エントリーを書く人と時期
Section titled “エントリーを書く人と時期”- 変更をするプルリクエストが、同じプルリクエストでその変更を記録します。
- 挙動の変更は、「アップグレードの前に読む挙動の変更」に書きます。上の一覧の最後の項目に書いたビルドの変更も、これに入ります。それらの変更は、「ビルドとテストの変更」に重ねて挙げてもかまいません。
- ディレクティブ、RubyのAPI、ハンドラへの追加のうち、既存の設定とスクリプトが前と同じに動くものは、「新機能」に書きます。
- そのほかの修正は、「不具合の修正」に書きます。
- ビルドの追加の変更と、コントリビューターやパッケージャーが知る必要のあるテストやCIの変更は、「ビルドとテストの変更」に書きます。ビルドの追加の変更の例は、新しくサポートするnginxのバージョンや、新しいビルドのオプションです。テストやCIの変更の例は、テストの新しいポートです。
- リリースの周期の中で、記録することがある最初のプルリクエストが、下のテンプレートからファイルとその日本語版を作ります。その周期の後のプルリクエストは、両方に追記します。こうすると、ファイルはいつも、次にタグを付けるバージョンを説明します。
vX.Y.Z.mdを作るプルリクエストは、src/http/ngx_http_mruby_module.hのMODULE_VERSIONもX.Y.Zにします。この値は、Nginx.module_versionが返し、nginxが起動するときにログに書きます。テストのスイートのtest/t/cases/module_and_request.rbは、この値を、このディレクトリで最も新しいvX.Y.Z.mdと比べます。そのため、値を変えずにファイルを作るプルリクエストでは、スイートが失敗します。ファイルの名前を別のバージョンに変えるプルリクエストは、値も一緒に変えます。「ファイル名」を見てください。nextでは、v3.0.0.mdが3.0.0の周期の全体の1つのファイルです。周期には、alpha、beta、rcのプレリリースも含みます。そのためnextでの値は3.0.0で、masterをnextへマージするプルリクエストは、値を3.0.0に保ちます。- 日本語版を必須にする前に作ったために、日本語版がまだ無いリリースのファイルがあります。そのようなファイルには、そのファイルに追記するか、そのファイルを編集する最初のプルリクエストが、日本語版を作ります。そのプルリクエストは、前のプルリクエストのエントリーも含めて、英語のファイルの全体を翻訳します。こうすると、2つのファイルに、同じエントリーがすべてそろいます。
- 同じプルリクエストで、
docs/directives/、docs/class_and_method/、docs/install/を、新しい挙動を説明するように更新します。リリースノートには何が変わったかを書き、これらのドキュメントには今どう動くかを書きます。 - AGENTS.mdのレビューでは、「アップグレードの前に読む挙動の変更」のエントリーが無い挙動の変更は「must fix」で、マージを止めます。テンプレートの行が欠けたエントリーも同じです。欠けた行には「変更の理由」も含みます。日本語版が無いエントリーと、日本語版が英語のエントリーと違うことを言うエントリーも、同じです。日本語を書かない作者には、レビュアーが日本語の文を渡してもかまいません。「新機能」「不具合の修正」「ビルドとテストの変更」のエントリーが無いことは、「should fix」です。そのようなエントリーの日本語版が無いことと、日本語版が英語のエントリーと違うことを言うことも、「should fix」です。レビューは、そのプルリクエスト自身のエントリーを確かめます。日本語版を必須にする前に作ったリリースのファイルについて、そのプルリクエストが日本語のファイルを作ることがあります。上の項目のファイルです。そのときは、前のエントリーの日本語版が無いことと、英語のエントリーと違うことを言うことを、そのプルリクエスト自身のエントリーと同じように評価します。つまり、「アップグレードの前に読む挙動の変更」では「must fix」で、ほかの節では「should fix」です。「変更の理由」の無い前のエントリーは、下の「タグの前に」に任せ、そのプルリクエストの所見にしません。
- 各タグの前に、セッションが、前のリリースの後にマージしたすべてのプルリクエストとファイルを照らし合わせます。直すものがあるときは、プルリクエストで直します。下の「タグの前に」を見てください。
ファイルの名前は、次にリリースするバージョンにします。別のバージョンでリリースすることになったときは、リリースの前に、ファイルとその日本語版の名前をgit mvで変えます。
- v3を昇格する前の
master:次の2.xのパッチリリースの名前です。タグv2.<minor>.<patch>の後のファイルは、v2.<minor>.<patch+1>.mdです。 next:3.0.0の周期の全体に、1つのファイルのv3.0.0.mdを使います。周期には、alpha、beta、rcのプレリリースも含みます。このファイルは、3.0.0を2.xの最新のリリースと比べます。masterをマージしてnextに入った変更は、その変更を出す2.xのリリースのファイルに記録し、v3.0.0.mdには重ねて記録しません。その2.xのリリースより前に3.0.0のタグを付けるときは、エントリーをv3.0.0.mdにコピーします。- v3を昇格した後は、
masterのファイルには次の3.xのリリースの名前を、v2.xのファイルには次の2.xのリリースの名前を、それぞれ付けます。
2.xから3.0.0にアップグレードする利用者は、自分のバージョンより新しい2.xのファイルを読み、その後にv3.0.0.mdを読みます。
vX.Y.Z.mdの日本語版は、同じディレクトリのvX.Y.Z.ja.mdです。たとえば、v2.7.1.mdの隣にv2.7.1.ja.mdがあります。日本語版は、原文である英語のファイルの翻訳です。日本語版には、英語のファイルと同じ節があり、同じエントリーが同じ順にあります。各エントリーは、英語のエントリーと同じことを言います。詳しくは、下の「日本語のファイル」にあります。このREADMEには、リリースのファイルとそのエントリーを作る、追記する、編集する、移す、コピーする、名前を変えるときの決まりを書いています。これらの決まりは、すべて日本語のファイルにも当てはまります。日本語のファイルの変更も、英語と同じプルリクエストでします。
v3の移行ガイドは、nextのdocs/proposals/v3-plan.mdで計画していて、v3.0.0.mdの「アップグレードの前に読む挙動の変更」の節を元に作ります。移行ガイドは、その節のすべてのエントリーを扱い、エントリーへリンクし、手順と例を加えます。移行ガイドには、変更の別の一覧はありません。そのため、3.0.0の各挙動の変更は、v3.0.0.mdの中の1か所にだけ記録します。
テンプレート
Section titled “テンプレート”これをdocs/releases/vX.Y.Z.mdにコピーします。すべての節を残し、エントリーの無い節には「None.」と書きます。docs/releases/vX.Y.Z.ja.mdには、下の「日本語のファイル」の見出しとラベルに置き換えてコピーします。
# ngx_mruby vX.Y.Z
## Behavior changes: read before upgrading
### <The change, in one line> (#<pull request>)
- Before: <what a configuration, script or build observed on the previous release>- Now: <what it observes on this release>- Why it changed: - The defect: <what the old behavior got wrong, with the issue or pull request that reports it> - Why the old behavior could not be kept: <what keeping it would have left broken; in an entry with "The reason:", what keeping it would have cost> - What the documentation promised: <what the docs said about it before this release, with a link, or that they described the old behavior or said nothing>- Affected: <the directives, handlers, methods, configurations or builds that see the difference>- What to do: <the change to make, or "nothing", with the reason>
## New features
- <The addition, in one line> (#<pull request>)
## Fixes
- <The fix, in one line> (#<pull request>)
## Build and test changes
- <A newly supported nginx version, a new build option, a test or CI change> (#<pull request>)
## Upgrading
<Supported nginx versions, whether rebuilding the module is enough, and the"What to do" lines above in one list.>次の変更は、「ビルドとテストの変更」だけでなく、「アップグレードの前に読む挙動の変更」に書きます。ビルドの要件を上げること、nginxのstableの系列やプラットフォームのサポートをやめること、ビルドのオプションを消すこと、同梱のmrubyか、デフォルトのmrbgemsを変えることです。
「変更の理由」は、前の挙動を前提にしていて、なぜリリースがその挙動を残さなかったのかと問う運用者に向けて書きます。その3つの行には、前の挙動が誤っていたという主張だけでなく、読み手が確かめられる根拠を書きます。
- 不具合:前の挙動が何を誤っていたかを、それを報告するissueかプルリクエストとともに書きます。不具合を直さないエントリーでは、この行に「背景:」と書き、変更の理由を書きます。不具合を直さないエントリーの例は、ビルドの要件を上げること、nginxの系列やプラットフォームのサポートをやめること、同梱のmrubyやデフォルトのmrbgemsを更新すること、v3が意図して加える変更です。
- 前の挙動を残せなかった理由:不具合を直すのに、なぜ「変更後」に書いた違いが必要だったかを書きます。つまり、前の挙動を残すと、何が壊れたままになったかです。「背景:」と書くエントリーでは、この行に、前の挙動を残すと何を失ったかを書きます。たとえば、古い依存先がもう受け取らない修正や、v3でその変更をする目的のうち、前の挙動では果たせないものです。
- ドキュメントが示していた挙動:このリリースの前に、
docs/がその挙動について何と書いていたかを、リンクとともに書きます。nginxが決める挙動では、nginxのドキュメントが何と書いていたかを書きます。これは、たいてい修正が戻す挙動です。ドキュメントが前の挙動を説明していたときや、何も書いていなかったときは、そう書きます。
エントリーの最後に、もう1つの行の「このリリースで変わらない挙動:」を置いてもかまいません。この行には、関係する挙動のうち、元のままのものを挙げます。読み手が、その挙動も変更に含まれると思うかもしれないときに使います。この行は任意で、テンプレートの中には含めません。
日本語のファイル
Section titled “日本語のファイル”vX.Y.Z.ja.mdは、vX.Y.Z.mdの英語の文から、エントリーごとに書きます。次の決まりに従います。
- 見出し、行のラベル、「None.」は、下のテーブルのものを使います。こうすると、2つのファイルをエントリーごと、ラベルごとに比べられます。テーブルに無いラベルには、作者が選んだ日本語のラベルを付け、その後に全角のコロンを置きます。たとえば、「影響の範囲」の行の中の「Unchanged:」です。
- 日本語の文字と、ラテン文字、数字、コードスパンの間に、スペースを入れません。
- 日本語の約物を使います。読点は「、」、句点は「。」です。引用する語は「」で囲み、行のラベルの後ろには、全角のコロンの「:」を置きます。
- em dashのU+2014、米印のU+203B、絵文字を使いません。
- 英語の文が丸括弧の中で説明していることは、節か独立の文にします。丸括弧を残すのは、識別子の周りと、正式な名前の後に初めて使う略語の周りだけです。識別子の例は、
(#566)というプルリクエストの番号です。 - コード、ディレクティブ、クラス、メソッドの名前、
error.logの行、コマンド、ファイルのパス、issueとプルリクエストの番号、リンクは、英語のままにします。 - 各段落と各リストの項目は、ソースの1行にし、
<br>も<wbr>も入れません。狭い画面で本文をどう折り返すかは、表示するGitHubかngx.mruby.orgのサイトが決めます。Markdownでは決めません。日本語は字の単位で折り返します。日本語の段落の中の改行は、GitHubがファイルから作るHTMLにも入り、Chromiumは2つの文字の間にスペースを表示します。
vX.Y.Z.mdでの表記 |
vX.Y.Z.ja.mdでの表記 |
|---|---|
# ngx_mruby vX.Y.Z |
# ngx_mruby vX.Y.Z |
## Behavior changes: read before upgrading |
## 更新前に確認する挙動の変更 |
- Before: |
- 変更前: |
- Now: |
- 変更後: |
- Why it changed: |
- 変更の理由: |
- The defect: |
- 不具合: |
- The reason: |
- 背景: |
- Why the old behavior could not be kept: |
- 前の挙動を残せなかった理由: |
- What the documentation promised: |
- ドキュメントが示していた挙動: |
- Affected: |
- 影響の範囲: |
- What to do: |
- 必要な対応: |
- Not changed by this release: |
- このリリースで変わらない挙動: |
## New features |
## 新機能 |
## Fixes |
## 不具合の修正 |
## Build and test changes |
## ビルドとテストの変更 |
## Upgrading |
## アップグレード |
None. |
ありません。 |
リリースを公開する前に、セッションが、ファイルとその日本語版を、マージしたものと照らし合わせます。セッションは、前のリリースの後にブランチへマージしたすべてのプルリクエストを挙げます。一覧はgit log --first-parent --merges <previous tag>..origin/<branch>で出します。各プルリクエストについて、エントリーがあるか、設定、スクリプト、ビルドから見えるものを何も変えないかを確かめ、無いエントリーを探します。「アップグレードの前に読む挙動の変更」のエントリーのうち、テンプレートの行が欠けたものも探します。欠けた行には「変更の理由」も含みます。日本語のファイルは、英語のファイルと比べます。同じ節があり、同じエントリーが同じ順にあり、各エントリーが英語のエントリーと同じことを言うかを比べます。src/http/ngx_http_mruby_module.hのMODULE_VERSIONがタグのバージョンであることも確かめます。値が最も新しいvX.Y.Z.mdと違うと、test/t/cases/module_and_request.rbのテストが失敗します。そのため、ファイルの名前がタグのバージョンになっていれば、下の全セルの実行が、リリースのコミットでこの値を確かめます。プレリリースのタグ、つまりv3.0.0-alpha.N、-beta.N、-rc.Nでは、タグのバージョンからプレリリースの接尾辞を除いたものと比べます。こうすると、この決まりより前にマージしたプルリクエスト、作者が決まりに従わなかったプルリクエスト、レビューが見落としたエントリーが見つかります。
直すものがあるときは、1つのプルリクエストが直します。これがチェックのプルリクエストです。無いエントリーを加え、テンプレートの行が欠けたエントリーを補います。リリースに日本語のファイルがまだ無いときは、英語のファイルを翻訳して作ります。無い日本語のエントリーを加え、違うエントリーを直します。別のバージョンでリリースするときは、両方のファイルの名前を変えます。このプルリクエストの本文には、各プルリクエストと、そのエントリーの節を挙げます。エントリーが無いプルリクエストには、「no entry」とその理由を書きます。本文には、2つのファイルを比べたことも書きます。このプルリクエストは、リリースの前にマージします。
直すものが無いときは、変えるファイルが無いので、セッションはプルリクエストを開きません。その代わりに、リリースの後に、nextのdocs/HANDOFF.mdにチェックの記録を書きます。書くのは、そのリリースをdocs/HANDOFF.mdに記録するプルリクエストです(AGENTS.mdの「Session handoff」を見てください)。記録には、各プルリクエストとそのエントリーの節、またはエントリーが無いことと理由、2つのファイルを比べたこと、前のリリースとの性能の比較(AGENTS.mdの「Design principles」を見てください)、下に書く全セルの実行を書きます。性能の比較がWARNかFAILになったときは、このときも、タグの前にオーナーに伝えます。
タグの前に、ベースブランチの先頭で、buildマトリクスの全セルを実行します。この先頭が、チェックの終わるコミットです。プルリクエストの4セルと手元の検査は、ほかのnginxのバージョンとリンクの方式を実行しません。そのため、それらの1つだけで落ちる変更は、全セルを実行しないと、タグのpushが始める実行で初めて落ちます。その時点では、リリースはもう出ています。古いnginxが受け付けないテストの設定が、その例です。チェックのプルリクエストには、開くときにラベルfull-matrixを付けます。コマンドはgh pr create --draft --label full-matrixです。リポジトリにこのラベルがなければ、gh label create full-matrixで一度だけ作ります。このラベルがあると、test.ymlの実行は全セルをビルドし、soakも実行します。ほかのプルリクエストでは4セルだけを実行します。docs/test/README.mdの「実行するジョブの選択」を参照してください。チェックのプルリクエストが無いときは、セッションがgh workflow run test.yml --ref <branch>で、ベースブランチの実行を始めます。入力baseの無い「Run workflow」は全セルをビルドし、結果をジョブci-ok (manual)で報告します。落ちたセルは、タグの前に、そのためのプルリクエストで直し、新しい先頭で全セルをもう一度実行します。そのプルリクエストにラベルfull-matrixがあり、その後に別のプルリクエストをマージしていなければ、そのプルリクエストの実行をこの実行として数えます。セキュリティの修正を出すリリースでは、この実行は、修正をマージする前の先頭で行います。修正を入れたツリーで手元で何を実行するかは、下の「セキュリティの修正」にあります。
nextでは、範囲は前のプレリリースのタグから始まります。最初のプレリリースでは、2.xで最新のリリースのタグから始まります。masterをnextへマージすると、masterへマージしたプルリクエストも一緒に入ります。それらはgit log --first-parent --merges <merge>^1..<merge>^2で一覧できます。そのようなマージでは、チェックは、それらのプルリクエストのそれぞれに、2.xのファイルのエントリーがあることを確かめます。「ファイル名」を見てください。3.0.0のタグの前には、タグがまだ無い2.xのリリースについて、そのエントリーをv3.0.0.mdにコピーします。
セッションは、オーナーがそのリリースの許可を出した後に、チェックの終わるコミットでリリースを公開します。チェックのプルリクエストがあるときはそのマージコミットで、無いときは全セルの実行がビルドしたベースブランチの先頭です。許可は、リリースノートを用意したセッションがオーナーに求めます。コマンドはgh release create <tag> --target <commit> --title <title> --notes-file <body>で、リリースとそのタグを作ります。その後にマージしたプルリクエストは次のリリースで出し、そのリリースのチェックが、それらのエントリーをそのリリースのファイルへ移します。後のコミットでリリースを公開したときは、そのコミットの後にマージしたプルリクエストについて、チェックを繰り返します。セキュリティの修正を出すリリースは、下の「セキュリティの修正」に書いた順に従います。
GitHubのリリース
Section titled “GitHubのリリース”セッションがリリースを公開するときは、その本文に、英語を先にして両方の文を載せます。最初に英語のファイルからコピーした「Behavior changes: read before upgrading」の節を載せ、変更が無いときは「None.」と書きます。次に日本語のファイルからコピーした同じ節、最後に2つのファイルへのリンクを載せます。GitHubが生成するプルリクエストの一覧は、本文にコピーしません。プルリクエストは、リリースノートに挙げてあります。nextのプレリリースでは、両方のファイルから、前のプレリリースの後に加わったエントリーと変わったエントリーをコピーします。それらはgit diff <previous pre-release tag> <new tag> -- docs/releases/v3.0.0.md docs/releases/v3.0.0.ja.mdで表示できます。最初のプレリリースでは、節の全体をコピーします。エージェントはファイルを用意し、オーナーの許可の後にリリースを公開します。アドバイザリはオーナーが公開します。AGENTS.mdを見てください。
リリースを公開したら、同じセッションがすぐにnextでsite.ymlを起動してサイトをビルドし直し、その実行が通るまで待ちます。ngx.mruby.orgのトップページは最新の安定版のリリースを表示し、ビルドはその版をgitのtagから読みます。リリースがtagを作っても、pushが無いのでビルドは始まりません。最後のマージのpushが始めた実行(masterではsite-dispatch.ymlを通して、nextではpushそのもので始まる実行)は、tagができる前にサイトをビルドしています。そのため、この実行が無いと、トップページは前のリリースを最新として表示し続けます。その前の実行もnextでのsite.ymlのworkflow_dispatchの実行で、起動の直後には新しい実行がまだ一覧に出ないことがあります。そのため、gh run listでいちばん新しい実行を取りません。実行のidは、site-dispatch.ymlと同じように、gh workflow runが出力するURLから取ります。URLが無いときは、起動の後に作られた最初の実行から取ります。
since=$(date -u -v-30S +%Y-%m-%dT%H:%M:%SZ 2>/dev/null || date -u -d '-30 seconds' +%Y-%m-%dT%H:%M:%SZ)out=$(gh workflow run site.yml --ref next) && echo "$out"run=$(echo "$out" | grep -Eo '/actions/runs/[0-9]+' | head -n 1 | cut -d / -f 4)for _ in 1 2 3 4 5 6 7 8 9 10 11 12; do [ -n "$run" ] && break sleep 5 run=$(gh run list --workflow site.yml --branch next --event workflow_dispatch --limit 5 \ --json databaseId,createdAt --jq "[.[] | select(.createdAt >= \"$since\")][0].databaseId // empty")donegh run watch "${run:?no run of site.yml on next since $since}" --exit-status起動の30秒前から数えるのは、手元のマシンとGitHubの時計のずれを見込むためです。その後に、セッションは公開したページを確かめます。curl -s https://ngx.mruby.org/ | grep -o 'Latest release: v[^"<]*'が新しい版を出力すれば、トップページは新しいリリースを表示しています。日本語のトップページのhttps://ngx.mruby.org/ja/では、最新のリリースはの後に版が出ます。
セキュリティの修正
Section titled “セキュリティの修正”セキュリティの修正は、アドバイザリの非公開のフォークで用意し、新しいバージョンとしてリリースします。SECURITY.mdを見てください。修正のエントリーは、両方のファイルとも、修正と同じ非公開のプルリクエストで書きます。こうすると、タグを付けたファイルとリリースの本文に、エントリーが入ります。
- エントリーは中立に書きます。影響を受けるコンポーネントの名前を挙げ、今何が見えるかを書きます。問題を悪用する方法や再現する方法と、それが脆弱性であることは、何も書きません。
- 修正が挙動を変えるときは、その「アップグレードの前に読む挙動の変更」のエントリーに、変更前、変更後、変更の理由、影響の範囲、必要な対応を、同じ中立の言葉で書きます。「変更の理由」には、不具合を「変更前」が説明する違いとしてだけ書きます。詳細は、アドバイザリのidが指します。idは、下に書くとおり、アドバイザリを公開したときに加えます。
- 非公開のプルリクエストのコミットメッセージと、テストの名前とコメントも、同じように中立に書きます。コードが今何をするかを書き、不具合を起こす方法や、不具合で何ができるかは書きません。アドバイザリを公開するまでは、アドバイザリのidも書きません。これらはマージで公開になり、その時点では利用者がまだアップグレードしておらず、アドバイザリもまだ公開していないことがあります。そのため、エントリーより多くのことを明かしません(AGENTS.mdの「Security」を見てください)。idは、アドバイザリを公開した後に、下のプルリクエストでだけリポジトリに入ります。
- アドバイザリの下書きは英語で書き、その後に同じ内容を日本語で書きます。オーナーは2026-10-29に、次のように依頼しました。「日本語でも後半でいいのでしっかりかいておいてほしい、今後は」
- オーナーがアドバイザリを公開したら、1つのプルリクエストが、両方のファイルのエントリーに、アドバイザリのidである
GHSA-xxxx-xxxx-xxxxを加えます。セッションは、リリースの本文にある両方の文に、idを加えます。そのプルリクエストでは、アドバイザリが扱う修正を、「不具合の修正」のほかの修正と分けて挙げてもかまいません。また、公開したアドバイザリと、src/にある公開の修正で分かる範囲で、「変更の理由」に不具合の原因を書いてもかまいません。
セキュリティの修正を出すリリースは、次の順で用意します。こうすると、リリースの前に、修正が公開になっている時間が、できるだけ短くなります。
- 「タグの前に」のチェックと、ベースブランチの先頭での
buildマトリクスの全セルの実行を、修正をマージする前に済ませます。チェックにプルリクエストが要るときは、そのプルリクエストもマージします。チェックは、その時点までにマージしたプルリクエストを扱います。修正の非公開のプルリクエストには、その修正のエントリーがあります。 - オーナーが、アドバイザリの非公開のフォークから修正をマージします(アドバイザリの「Merge pull request(s)」)。その直後に、セッションが、修正のマージコミットでリリースを公開します。これは、チェックの終わるコミットでリリースを公開するという決まりの例外です。2つのマージの間に別のプルリクエストをマージしたときは、修正をマージする前に、そのプルリクエストのエントリーを確かめます。
リポジトリの普段の設定のままでは、GitHubは手順2のマージを拒みます。セッションがマージの準備をし、マージが通る状態になってから、オーナーにマージを依頼します。これはセッションの手順で、オーナーが決めたことではありません。
-
マージは、アドバイザリのページの
https://github.com/matsumotory/ngx_mruby/security/advisories/<id>で行います。アドバイザリのフォームの一番下で、「This advisory is ready to be merged」の下にあるボタン「Merge pull request(s)」を押します。GitHubのドキュメントを見てください。非公開のフォークにあるプルリクエストのページからは、マージできません。GitHubは一時的な非公開のフォークでCIを実行しないので、そのページでは必須のチェックがいつまでも保留のままです。そのため、オーナーへの依頼には、開くページと各ページで押すものを挙げ、ページはアドバイザリのページだけにします。フォークのプルリクエストへのリンクは入れません。 -
修正のプルリクエストを、フォークで開いている唯一のプルリクエストにします。GitHubは、フォークで開いているプルリクエストをすべて一度にマージし、フォークのデフォルトブランチに向いたプルリクエストが2つ以上あるとマージを止めます。セッションは、そのプルリクエストがdraftでないことと、コンフリクトが無いことも確かめます。
-
プルリクエストのヘッドに、ベースブランチの先頭を含めます。こうすると、マージ後のツリーはそのヘッドのツリーと同じになり、手元の実行が検査したツリーになります。2つのアドバイザリの修正を続けてマージするときは、2つ目のプルリクエストのヘッドに、1つ目のプルリクエストのヘッドを含めます。
-
ルールセット
protected-linesは、masterとnextにci-okを必須とし、リポジトリの管理者がプルリクエストに限ってbypassできるようにしています。GitHubのページは、アドバイザリからのマージにはブランチの保護ルールを適用しないと書いています。しかし、このリポジトリのrule suiteを見ると、このルールセットはそれでも適用されています。そのようなマージでは毎回、ルールrequired_status_checksがci-okを待つ状態で失敗し、結果はbypassで、マージはbypassのモードがalwaysの間に行われていました。直近1か月の結果はgh api "repos/matsumotory/ngx_mruby/rulesets/rule-suites?ref=refs/heads/master&time_period=month&per_page=100"で一覧でき、モードはルールセットの履歴で分かります。そこで、セッションは、そのリリースについてオーナーの許可を得たうえで、マージを依頼する直前にbypassのモードをalwaysにします。Tは、このリリースのために新しく作るディレクトリで、リポジトリの外か.claude/tmp/の下に置きます。下の2つのブロックは、どちらもTを使います。mkdir -p "${T:?}"R=repos/matsumotory/ngx_mruby/rulesetsID=$(gh api $R --jq '.[] | select(.name == "protected-lines") | .id')[ -s "$T/restore.json" ] ||gh api $R/$ID | jq -S '{name,target,enforcement,conditions,rules,bypass_actors}' > "$T/restore.json"jq -e '.bypass_actors | all(.bypass_mode == "pull_request")' "$T/restore.json" > /dev/null &&jq '.bypass_actors |= map(.bypass_mode = "always")' "$T/restore.json" > "$T/open.json" &&gh api -X PUT $R/$ID --input "$T/open.json" > /dev/null元に戻すためのコピーは一度だけ書きます。ルールセットは、bypassのモードが
pull_requestであるコピーからだけ変えます。こうすると、2回目に実行しても、変えた後のルールセットでコピーを上書きしません。最後のマージがブランチに入ったら、セッションはすぐにルールセットを元に戻し、コピーと比べます。R=repos/matsumotory/ngx_mruby/rulesetsID=$(gh api $R --jq '.[] | select(.name == "protected-lines") | .id')gh api -X PUT $R/$ID --input "${T:?}/restore.json" > /dev/nullgh api $R/$ID | jq -S '{name,target,enforcement,conditions,rules,bypass_actors}' | diff "$T/restore.json" -ルールセットが元のとおりなら、最後の行は何も出力しません。違いが出たときは、ルールセットが元に戻っていないので、ブロックをもう一度実行します。2つ目のブロックは
RとIDを自分で設定するので、1つ目と別のシェルでも動きます。bypassのモードがalwaysの間は、管理者がmasterとnextへ直接pushすることもできます。そのため、セッションはその状態のまま残しません。オーナーが後でマージするときは、セッションはルールセットを元に戻しておき、そのときにもう一度alwaysにします。 -
このマージを裏付けるCIの実行はありません。その代わりになるのは、非公開のプルリクエストに引用した手元の実行です。静的モジュールと動的モジュールでのスイート、sanitizerのビルド、valgrindはAGENTS.mdの「Build and test」の手順で、性能の比較はcallgrindで性能を比べるの手順で実行します。プルリクエストが変えるリリースノートの検査も、これに入ります。この検査はサイトの2.xページの検査で、プルリクエストの
vX.Y.Z.mdとvX.Y.Z.ja.mdを、手元のnextのチェックアウトのdocs/releases/にコピーし、pushしないローカルのコミットにしてから実行します。手順はその一覧の最後の段落にあり、コピーは手元にだけ残ります。これらのファイルは、masterをnextへマージすると、サイトの3.xのページになります。この検査をしないと、サイトの日本語のページの検査は、ファイルが公開になった後に、そのマージかサイトのデプロイで初めて落ちます。また、リリースを公開するツリー(最後の修正のプルリクエストのヘッド)で、静的モジュールとbuildマトリクスでいちばん古いnginx、動的モジュールと動的モジュールの標準のセルのnginxの2つのスイートも、手元で実行します。どちらのバージョンも.github/workflows/test.ymlのマトリクスから取ります。今は、masterでは静的が1.26.3、動的が1.30.6で、nextでは静的も動的も1.30.6です。どちらもLinuxのコンテナで実行します。バージョンの切り替え方は、docs/test/README.mdの「実行するジョブの選択」にあります。「タグの前に」の全セルの実行には修正が入っておらず、タグのpushが始める実行はリリースの後なので、これらのバージョンで修正を確かめるのは、この2つの実行だけです。最後のマージの後、リリースの前に、セッションはベースブランチをfetchし、そのツリーが、それらの実行で検査したツリーと同じかを確かめます。git rev-parse origin/<base>^{tree}とgit rev-parse <tested commit>^{tree}が同じidを出力すれば同じです。違うときは、セッションはそのツリーからリリースを公開せず、何が違うかをオーナーに伝えます。 -
セッションは、オーナーにアドバイザリの公開を頼む前に、下書きをリリースと照らし合わせます。修正済みのバージョンに、出したバージョンが入っているかを確かめます。修正済みのバージョンは
gh api repos/matsumotory/ngx_mruby/security-advisories/<id> --jq '.vulnerabilities[].patched_versions'で表示できます。文に、リリースノートと食い違うこと(バージョン、影響を受けるディレクティブとメソッド、今何が見えるか)が無いかも確かめます。下書きはバージョンが決まる前に書くので、リリースと違うバージョンを書いたままアドバイザリを公開すると、利用者が誤ったバージョンへアップグレードします。違いがあれば、オーナーへの依頼にそれを書き、公開の前に下書きを直せるようにします。 -
リリースの後に、オーナーが同じページで、アドバイザリのフォームの一番下にある「Publish advisory」を押してアドバイザリを公開します。GitHubのドキュメントを見てください。「Request CVE ID later」を選んだときは、ボタンの表示が「Request CVE」になります。このときは、ルールセットを変える必要はありません。
アドバイザリを公開するまでは、公開のリポジトリのどこにも、脆弱性について書きません。AGENTS.mdの「Security」を見てください。