Release preflight guide
Release Guardian
Codex 向けの release preflight と safe-fix を扱う解説ページです。リポジトリ読解、safe checks、狭い low-risk fix、そして構造化された verdict までを repository-first に整理します。
Current status
公開版リポジトリあり docs、templates、helper scripts、self-tests を含んだ状態で公開されています。Core workflow
inspect → classify → optional safe-fix → report 公開直前の最終パスを、実務的なチェックと明示的な出力で扱います。Modes
4つの主要モード report-only、safe-fix、blocker-first、release-report の4モードを含み、self-test で確認できます。Repository
GitHub で公開中 instructions、examples、templates、scripts、tests を一つのリポジトリにまとめています。これは何か
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、infra governance、完全自動リリース bot を探している場合は方向が違います。
何をチェックするか
現在のリポジトリは、web repository 向けの public-release basics を中心に扱います。
Universal checks
- README の有無と明瞭性
- LICENSE の有無
- favicon の有無
- title と meta description
- OGP や social metadata の基本
- canonical の基本
robots.txtsitemap.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 の両方として読むと分かりやすいです。
- まず
README.mdを読む。 公開上の位置づけと boundary を掴みます。 SKILL.mdを読む。 operational behavior、safety default、workflow、output contract を確認します。AGENTS.mdとdocs/を開く。 maintenance rules、check coverage、stack support、safety policy を把握します。examples/とtemplates/を見る。 report shape と intended usage がかなり見やすくなります。- 最後に script を 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 も使えます。
なぜ NicheWorks が公開するのか
NicheWorks は、実務で使える小さなツールや workflow asset を公開するラインです。Release Guardian もその一つで、現実に困りやすい「公開直前の雑な最終確認」を狭く扱う repository asset として公開されています。
万能監査を名乗るのではなく、examples、tests、release discipline を少しずつ積み上げていく working asset として置かれています。
FAQ
Release Guardian は単なるチェックリストですか?
違います。実際のリポジトリ読解を前提にした Codex 向けの repository asset で、instructions、templates、helper scripts、self-tests を含みます。
何をするリポジトリですか?
対象リポジトリを inspect し、公開前の practical な抜け漏れをチェックし、必要に応じて narrow な safe-fix を行い、構造化された verdict を返します。
ローカルで実行できますか?
できます。local entry script と、report-only、safe-fix、blocker-first、release-report の self-tests が含まれています。
safe-fix は何を直しますか?
meta description placeholder、favicon reference、robots.txt、sitemap.xml など、公開前の狭い low-risk 領域だけを対象にします。
これはセキュリティ監査ツールですか?
違います。release-preflight guard であり、完全な security、legal、compliance audit を置き換えるものではありません。
関連リンク
免責事項
このページおよびリンク先のリポジトリは、情報提供と practical workflow の整理を目的として公開されています。内容の完全性、特定目的への適合性、公開の成功は保証されません。実際の release 判断には最終的な human review が必要です。