# publish-guard

Adopt this skill: https://proskills.md/skills/other/zack-dev-cm-publish-guard-skill-publish-guard

Page: https://proskills.md/skills/other/zack-dev-cm-publish-guard-skill-publish-guard
This document is the public skill bundle for that page. It contains SKILL.md and every helper file the catalog carries. No login is required.

## File: skill/publish-guard/SKILL.md
size: 3041
upstream: https://github.com/zack-dev-cm/publish-guard/blob/main/skill/publish-guard/SKILL.md

```text
---
name: publish-guard
description: Review a repo, README, SKILL.md, release notes, and social copy before publishing. Catch leak risks, weak public-facing copy, broken first-run paths, and internal operator language before GitHub or ClawHub release.
homepage: https://zack-dev-cm.github.io/
license: MIT-0
user-invocable: true
metadata: {"openclaw":{"homepage":"https://zack-dev-cm.github.io/","skillKey":"publish-guard","requires":{"anyBins":["python3","python"]}}}
---

# Publish Guard

## Goal

Audit the public surface before release:

- README
- `SKILL.md`
- agent metadata
- release notes
- social copy
- obvious leak patterns

The output should answer one question clearly: publish now, or fix specific items first.

## Use This Skill When

- the user wants to publish a GitHub repo or ClawHub skill
- the user wants a public-surface audit before a launch
- the repo may contain internal launch docs, secret-shaped strings, or operator-only wording
- the README or `SKILL.md` feels too insider-heavy or too long
- the first-run path may be broken, vague, or buried

## Quick Start

1. Scan for obvious leak patterns.
   - `python3 {baseDir}/scripts/scan_leaks.py --root <repo> --out <json>`
2. Scan the public surface for audience-fit problems.
   - `python3 {baseDir}/scripts/scan_public_surface.py --root <repo> --out <json>`
3. Score the README or primary landing page.
   - `python3 {baseDir}/scripts/score_launch_copy.py --readme <repo>/README.md --out <json>`
4. Render one decision-ready audit.
   - `python3 {baseDir}/scripts/render_public_audit.py --repo <repo> --leaks <json> --surface <json> --copy <json> --out <md>`

## Operating Rules

- Treat `README.md`, `SKILL.md`, `agents/openai.yaml`, release notes, and social-post files as public.
- Public copy should describe the user job before it explains the internal theory.
- A public quick start should appear near the top and should be runnable without hidden context.
- Keep public default prompts short. Move deeper operating rules into the skill body or scripts.
- Flag internal launch docs in the repo unless they are intentionally private and excluded from the public package.
- Prefer a small set of concrete findings over a broad essay.

## What To Flag

- absolute filesystem paths
- localhost URLs and websocket endpoints
- token-shaped strings and credential-like URLs
- missing or buried quick starts
- giant inventory sections or excessively long `SKILL.md` files
- public prompts that read like internal control instructions
- README intros that compare the repo to five other projects before explaining what it does

## Bundled Scripts

- `scripts/scan_leaks.py`
  - Search the repo for obvious leak patterns and secret-shaped strings.
- `scripts/scan_public_surface.py`
  - Inspect README, `SKILL.md`, release notes, and public metadata for audience-fit issues.
- `scripts/score_launch_copy.py`
  - Produce a simple launch-copy score for the primary README.
- `scripts/render_public_audit.py`
  - Merge the JSON outputs into one concise markdown audit.
```

## File: README.md
upstream: https://github.com/zack-dev-cm/publish-guard/blob/main/README.md

````text
# Publish Guard

**Review a repo, README, `SKILL.md`, and release surface before you publish.**

Publish Guard is a small public OpenClaw skill for pre-release audits. It catches obvious leak risks,
public-audience mismatch, broken first-run copy, and launch-surface problems before a GitHub repo or
ClawHub skill goes live.

## Proof

```md
# Publish Guard Audit

- Recommendation: **Publish**
- Launch copy score: **100/100** (publish-ready)
- Leak scan: **0** findings
- Public surface scan: **0** findings
```

## Quick Start

```bash
python3 skill/publish-guard/scripts/scan_leaks.py \
  --root . \
  --out /tmp/publish-guard-leaks.json

python3 skill/publish-guard/scripts/scan_public_surface.py \
  --root . \
  --out /tmp/publish-guard-surface.json

python3 skill/publish-guard/scripts/score_launch_copy.py \
  --readme README.md \
  --out /tmp/publish-guard-copy.json

python3 skill/publish-guard/scripts/render_public_audit.py \
  --repo . \
  --leaks /tmp/publish-guard-leaks.json \
  --surface /tmp/publish-guard-surface.json \
  --copy /tmp/publish-guard-copy.json \
  --out /tmp/publish-guard-audit.md
```

## What It Catches

- absolute paths, localhost URLs, websocket endpoints, and token-shaped strings
- operator-facing or internal language near the top of a public README
- missing or buried quick starts
- oversized public `SKILL.md` files
- internal launch docs accidentally left in a public repo
- public prompts and metadata that read like internal control text instead of a user-facing product

## Included

- `skill/publish-guard/SKILL.md`
- `skill/publish-guard/agents/openai.yaml`
- `skill/publish-guard/scripts/scan_leaks.py`
- `skill/publish-guard/scripts/scan_public_surface.py`
- `skill/publish-guard/scripts/score_launch_copy.py`
- `skill/publish-guard/scripts/render_public_audit.py`

## Use Cases

- review a GitHub repo before making it public
- review a ClawHub skill before publishing or bumping a version
- compare two README directions and choose the cleaner public story
- audit release notes and social copy for leaks and audience mismatch

## License

MIT No Attribution (MIT-0)
````
