Appearance
Release Checklist
Use this checklist when a runtime change could affect public docs.
NPM Release Automation
PolitiClaw publishes @politiclaw/politiclaw through a reviewed release PR plus a human-gated GitHub Release.
- Run the Prepare npm release GitHub Action and choose
patch,minor, ormajor. - Review and merge the generated release PR after checks pass.
- Publish a GitHub Release tagged
vX.Y.Zfrommain. - The Publish npm package workflow verifies the tag, reruns
npm run release:check, confirms the version is not already published, and publishes with npm provenance.
One-time setup:
- Configure npm Trusted Publishing for
@politiclaw/politiclawwith providerGitHub Actions, repositoryPolitiClaw/PolitiClaw, workflowpublish-npm.yml, and environmentnpm-production. - Create the GitHub environment
npm-productionwith required reviewer protection.
Manual Docs Refresh
- Update the runtime source of truth first.
- Regenerate docs with
npm run docs:generate. - Run
npm run docs:check. - Re-read any affected guide or maintainer pages for overclaims.
- Verify the relevant generated pages changed in the expected way.
- Build the docs site before merging or releasing.
Changes That Usually Need A Docs Refresh
- tool additions, removals, or renamed parameters
- config-schema changes
- source coverage changes
- cron template changes
- skill additions or renamed skill directories
- storage migrations
