Release Guardian

What it is

Release Guardian is a practical release-preflight repository asset for Codex-style repository work. It is designed for the final pass before launch, when a project may technically run but still be weak as a public release.

Typical problems at that stage include missing title or description metadata, missing crawl files, weak public-facing basics, accidental noindex, README drift, unclear deploy assumptions, or a vague sense that a repo is “probably ready” without a structured verdict.

This repository exists to turn that vague final pass into a repeatable workflow: inspect the repo, run safe checks, classify blockers vs warnings, optionally apply only narrow low-risk fixes, and return a consistent release-readiness result.

Who it is for

This project is a good fit for people shipping public-facing repositories and wanting a more disciplined last-mile release check. It is especially useful if you work inside real repositories instead of abstract examples and want a practical release verdict with explicit boundaries.

• Individual builders shipping small web tools or public utility repos.
• People using Codex or agent-assisted repository workflows.
• Maintainers who want a cleaner ship / no-ship style check.
• Teams that want narrow safe-fix behavior instead of broad automatic edits.
• Anyone who wants practical release basics to be explicit, not improvised.

It is a worse fit if you are looking for a full security audit suite, legal review system, accessibility audit, privacy audit, infrastructure governance framework, or autonomous release bot.

What it checks

The current repository focuses on practical public-release basics for web repositories.

Universal checks

• README presence and clarity
• LICENSE presence
• favicon presence
• title and meta description
• OGP and social metadata basics
• canonical basics
• robots.txt
• sitemap.xml
• 404 handling
• accidental noindex
• obvious docs drift
• public-facing support, contact, and disclaimer basics

Framework-oriented checks

The implementation can inspect common public web-app shapes including static HTML repos, Vite-style repos, React-style repos, and Next.js-like metadata entry structures.

Release-readiness checks

When repo-defined scripts exist, the CLI can run practical checks such as build, lint, typecheck, and test, then classify the results as blockers or warnings.

Modes

What’s included

The repository is organized as a practical, reusable package rather than a single prompt file.

Core instructions

README.md, SKILL.md, AGENTS.md, DISCLAIMER.md, and LICENSE.

Documentation

docs/ covers checks, modes, stack support, safety boundaries, output format, examples, and quality bar.

Examples and templates

examples/ and templates/ show starter prompts, sample outputs, PR comment shapes, issue shapes, and AGENTS snippets.

Scripts and tests

scripts/release_guardian.py is the main local entry point. Helper scripts support stack detection, file checks, signal collection, report rendering, and build-check execution. tests/selftest_release_guardian.py verifies the main four modes against synthetic repositories.

How to use it

The easiest way to approach the repository is to treat it as both a documented skill repo and a runnable local utility.

1. Start with README.md. This gives the public positioning and the intended boundaries.
2. Read SKILL.md. This describes the operational behavior, safety defaults, workflow, and output contract.
3. Open AGENTS.md and docs/. These clarify maintenance rules, check coverage, stack support, and safety policy.
4. Use examples/ and templates/. These make the reporting shape and intended usage much easier to see.
5. Run report-only on a target repository first. This is the practical path if you want to use it in real repo work.

If you only want the high-level concept, the README and examples are enough. If you want to use it in real work, the CLI, safety notes, and self-tests matter too.

CLI usage

The repository includes a working local entry point for practical checks.

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

Useful flags include --skip-commands, --json-out, and --md-out.

Glossary

release-preflight

A practical pre-launch check before publishing a repository or web project.

safe-fix

A narrow automatic fix mode intended for limited low-risk release basics. It still requires diff review.

blocker

A serious issue that should stop or delay release until fixed.

warning

An issue that may not block release but should be reviewed before shipping.

verdict

The final structured judgment produced by the workflow.

Why NicheWorks publishes it

NicheWorks publishes small, practical tools and workflow assets that are meant to be used in real work. Release Guardian fits that model: it is a narrowly scoped repository asset for a real operational problem, the rushed and inconsistent final pass before shipping.

It is not positioned as a magic auditor. It is positioned as a useful working asset that can keep improving through better examples, better tests, and tighter release discipline over time.

FAQ

Links