Release Guardian

これは何か

Release Guardian は、Codex を使った repository work に向けた practical な release-preflight asset です。目的は、公開直前にありがちな曖昧な最終確認を、repeatable な実務フローに変えることです。

その段階で起きやすい問題には、title や description の欠落、crawl 系ファイルの不足、public-facing basics の弱さ、 accidental noindex、README drift、deploy assumption の曖昧さなどがあります。

このリポジトリは、それらを「とりあえず見る」ではなく、repo を inspect し、safe checks を走らせ、blocker と warning を分け、必要な場合だけ狭い safe-fix を行い、最後に verdict を返す形に整理します。

誰向けか

このプロジェクトは、public-facing repository を公開する前に、もう少し厳密な最終確認をしたい人に向いています。特に、抽象的な安心感ではなく、blocker と warning が明確に分かれた ship / no-ship 判定を求める人には相性がよいです。

• 小規模 web tool や utility repo を公開する個人開発者。
• Codex や agent-assisted repository workflow を使う人。
• 公開直前の確認を構造化したい maintainer。
• broad automatic edit ではなく narrow safe-fix を求める人。
• release basics をその場の感覚で済ませたくない人。

逆に、full security audit、legal review、accessibility audit、privacy audit、infra governance、完全自動リリース bot を探している場合は方向が違います。

何をチェックするか

現在のリポジトリは、web repository 向けの public-release basics を中心に扱います。

Universal checks

• README の有無と明瞭性
• LICENSE の有無
• favicon の有無
• title と meta description
• OGP や social metadata の基本
• canonical の基本
• robots.txt
• sitemap.xml
• 404 handling
• accidental noindex
• obvious docs drift
• support、contact、disclaimer などの public-facing basics

Framework-oriented checks

実装では、static HTML repo、Vite 系、React 系、Next.js に近い metadata entry 構造も inspect できます。

Release-readiness checks

repo-defined script がある場合、build、lint、typecheck、test などを practical に実行し、結果を blocker / warning として分類します。

モード

含まれているもの

このリポジトリは、一枚の prompt ではなく、再利用しやすい package として構成されています。

Core instructions

README.md、SKILL.md、AGENTS.md、DISCLAIMER.md、LICENSE。

Documentation

docs/ に checks、modes、stack support、safety boundary、output format、examples、quality bar を収録しています。

Examples and templates

examples/ と templates/ に、starter prompt、sample output、PR comment、issue、AGENTS snippet などを収録しています。

Scripts and tests

scripts/release_guardian.py が main entry point です。helper scripts は stack detection、file checks、signal collection、report rendering、build checks を補助し、tests/selftest_release_guardian.py が4モードを synthetic repo で検証します。

使い方

このリポジトリは、documented skill repo と runnable local utility の両方として読むと分かりやすいです。

1. まず README.md を読む。 公開上の位置づけと boundary を掴みます。
2. SKILL.md を読む。 operational behavior、safety default、workflow、output contract を確認します。
3. AGENTS.md と docs/ を開く。 maintenance rules、check coverage、stack support、safety policy を把握します。
4. examples/ と templates/ を見る。 report shape と intended usage がかなり見やすくなります。
5. まず report-only を target repo に対して実行する。 実務で使うならここが本番です。

全体像だけ知りたいなら README と examples で十分です。実務で使うなら CLI、安全上の注意、self-test まで見るのが自然です。

CLI

ローカルで実行できる main entry point が含まれています。

python3 scripts/release_guardian.py /path/to/target-repo --mode report-only
python3 scripts/release_guardian.py /path/to/target-repo --mode safe-fix
python3 scripts/release_guardian.py /path/to/target-repo --mode blocker-first
python3 scripts/release_guardian.py /path/to/target-repo --mode release-report --md-out /tmp/release-report.md

--skip-commands、--json-out、--md-out といった flag も使えます。

用語メモ

release-preflight

公開前確認。公開前にリポジトリやWebプロジェクトの抜け漏れを確認する作業。

safe-fix

低リスク範囲に限定した自動修正。ただしファイルを書き換えるため、差分確認は必須。

blocker

公開前に止めるべき重大問題。

warning

公開は可能でも、公開前に確認すべき問題。

verdict

最終判定。チェック結果をもとにした構造化された判断。

なぜ NicheWorks が公開するのか

NicheWorks は、実務で使える小さなツールや workflow asset を公開するラインです。Release Guardian もその一つで、現実に困りやすい「公開直前の雑な最終確認」を狭く扱う repository asset として公開されています。

万能監査を名乗るのではなく、examples、tests、release discipline を少しずつ積み上げていく working asset として置かれています。

FAQ

関連リンク