Publier la documentation

VérifiéPrudence

Fusionner une branche de documentation approuvée sur main via PR squash ou fusion locale. Confirme avant toute étape irréversible.

Spar Skills Guide Bot
DevOpsIntermédiaire
30/07/2026
Claude Code
#documentation#git#pull-request#release#squash-merge

Recommandé pour

Synthèse automatique

Publie une branche de documentation approuvée sur main, soit en ouvrant une PR squash, soit en fusionnant localement, avec confirmation obligatoire avant le déploiement en production.

Points forts

  • Vérifie le verdict d'approbation dans TECH.md et bloque la publication si la revue n'est pas approuvée
  • Génère un corps de PR structuré liant les artefacts (GOAL, PLAN, research, REVIEW) via des permaliens ancrés sur le SHA
  • Impose une confirmation humaine via AskUserQuestion avant l'étape irréversible
  • Prend en charge le mode PR (par défaut) et le mode fusion locale, et refuse de cibler la branche dev

Limites

  • Suppose une arborescence de fabrique spécifique (spec/{slug}/, TECH.md, GOAL.md, .agents/factory) propre à ce dépôt
  • Les chemins d'outils Bash autorisés sont codés en dur et liés à cet environnement
  • La fusion sur main déclenche un déploiement en production sans barrière de staging, ce qui reste risqué
Quand l'utiliser

À utiliser comme dernière étape lorsqu'une branche de documentation a passé la revue et doit être livrée sur main.

Quand l'éviter

À éviter sur un dépôt sans la structure spec/ ni les fichiers TECH.md/GOAL.md, ou lorsque vous ne voulez pas déclencher le déploiement automatique en production.

Analyse de sécurité

Prudence
Score qualité87/100

The skill is a documentation-publishing workflow that uses git/gh to push branches, open squash PRs, and optionally merge or squash-merge to main. Its highest-risk action is triggering a production deploy on merge, but this is clearly flagged and gated behind a mandatory human confirmation and an 'approved' review-verdict check. Tool grants are powerful (push/merge) yet legitimate and scoped to git/gh plus one local script; there is no exfiltration, destructive command, or safety-disabling behavior, so it warrants caution rather than risky.

Points d'attention
  • •Merging to main auto-deploys to production (~5 min); irreversible outward action, but gated by a mandatory AskUserQuestion confirmation and an explicit approved-verdict requirement
  • •Broad git write scopes granted: push, merge, switch/checkout, add, commit, plus gh pr/gh repo — powerful but appropriate for a publish workflow
  • •Bash(.venv/bin/python .agents/factory/bin/meta_status.py *) executes a repository-local Python script; trust depends on that script, though the path is narrowly scoped
  • •No network fetches via curl/wget, no secret handling, no destructive filesystem operations, no obfuscated payloads
Comment cette analyse est faite

Exemples

Open a PR for the approved docs branch
/docs-publish and open the squash PR to main for my current documentation branch.
Check status before publishing
/docs-publish status — show the review verdict, commits ahead of main, and any existing PR.
Merge locally after review
/docs-publish local — squash-merge my approved docs branch into main locally without pushing.

name: docs-publish description: >- Land an approved documentation branch on main. Default: push the branch and open a squash PR to main with a rich, artifact-linked body (Summary/Goal/Design/Research/Phases/Verification). Alternative (local): squash-merge into main locally. Confirms before any irreversible/outward step; never targets dev. NOTE: merging to main auto-deploys to production (Geddes) within ~5 minutes — this is the one irreversible, outward step. Final step of the documentation factory. disable-model-invocation: true argument-hint: "[pr (default) | local] [merge]" allowed-tools: Read, Grep, Glob, AskUserQuestion, Bash(git status *), Bash(git branch *), Bash(git log *), Bash(git diff *), Bash(git rev-parse *), Bash(git fetch *), Bash(git push *), Bash(git switch *), Bash(git checkout *), Bash(git merge *), Bash(git add *), Bash(git commit *), Bash(gh pr *), Bash(gh repo *), Bash(.venv/bin/python .agents/factory/bin/meta_status.py *)

docs-publish — ship the branch to main

Open a squash PR to main (default) or squash-merge locally. Merging to main deploys to production within ~5 minutes — there is no staging gate. Always confirm before the irreversible step, and never target dev (CI blocks dev → main anyway; dev is the a11y branch).

Step 0 — status (when requested)

Report the review verdict, commits vs main, and any existing PR (gh pr status). No action.

Step 1 — Pre-flight

  • On the feature/|fix/|refactor/ branch, clean tree; resolve {slug}.
  • Read kind and review.verdict from TECH.md — STOP if the verdict is not approved (unless the human explicitly overrides). If review flagged a human gate, confirm sign-off happened.
  • git fetch origin; flag if the branch is behind main.

Step 2 — Compose PR title + body

  • Title: [{kind}] {imperative summary} synthesized from GOAL.md (never Conventional Commits like feat:/docs:).
  • Body (link artifacts via SHA-pinned permalinks using git rev-parse HEAD; link, don't quote):
    • Summary — what changed and why (from GOAL).
    • Goal → spec/{slug}/GOAL.md
    • Design → spec/{slug}/PLAN.md
    • Research → spec/{slug}/research/*.md (if present)
    • Phases completed → from the TECH.md FSM (id · name · satisfies R-IDs)
    • Verification → from spec/{slug}/REVIEW.md (build/render/link/nav/a11y results, verdict)
    • 🔧 Harness feedback (only if .venv/bin/python .agents/factory/bin/meta_status.py spec/{slug}/META.md --status open reports open > 0) → a short, collapsed section listing each open finding (id · severity · title), then label the PR: gh pr edit --add-label harness-feedback. Keep it terse (link to META.md for detail) so it doesn't dominate the PR; route them later with /docs-harness. Do not write or resolve findings here.
    • Closes #NN (this auto-closes the issue — main is the default branch)
    • trailing line: 🤖 Generated with [Claude Code](https://claude.com/claude-code)

Step 3 — Confirm with the human (mandatory)

AskUserQuestion: mode (PR vs local), title, and body. This is the last gate before production.

Step 4a — PR (default)

git push -u origin {branch} → gh pr create --base main --head {branch} --title "…" --body-file …. If merge is confirmed: gh pr merge {N} --squash --subject "{title}" --body "…" --delete-branch.

Step 4b — local

git switch main && git pull --ff-only → git merge --squash {branch} → git commit -m "{title}" → git branch -D {branch}. Do not push main unless explicitly asked (a push to main triggers the production deploy).

Step 5 — Report

PR URL / merge result, the squash subject, and the retained spec/{slug}/ artifacts. Remind the human that a merge to main rolls out to docs.rcac.purdue.edu within ~5 minutes.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/publish-documentation-ms71b3cz/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/publish-documentation-ms71b3cz' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/publish-documentation-ms71b3cz/download' --output '.skill-downloads/publish-documentation-ms71b3cz/SKILL.md.part' && mv '.skill-downloads/publish-documentation-ms71b3cz/SKILL.md.part' '.skill-downloads/publish-documentation-ms71b3cz/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Grep, Glob, AskUserQuestion, Bash(git status *), Bash(git branch *), Bash(git log *), Bash(git diff *), Bash(git rev-parse *), Bash(git fetch *), Bash(git push *), Bash(git switch *), Bash(git checkout *), Bash(git merge *), Bash(git add *), Bash(git commit *), Bash(gh pr *), Bash(gh repo *), Bash(.venv/bin/python .agents/factory/bin/meta_status.py *)

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/publish-documentation-ms71b3cz/SKILL.md' && test -s '.skill-downloads/publish-documentation-ms71b3cz/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs-publish' && cp -R '.skill-downloads/publish-documentation-ms71b3cz' '.claude/skills/docs-publish'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/publish-documentation-ms71b3cz'

openskills read 'publish-documentation-ms71b3cz'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/publish-documentation-ms71b3cz/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires