Skip to content

70-release-commit-and-docs.md

Latest commit

 

History

History
79 lines (64 loc) · 4.82 KB

70-release-commit-and-docs.md

File metadata and controls

79 lines (64 loc) · 4.82 KB
layout default
title Agent release, commit, and docs rules
permalink /contributing/agent-rules/release-commit-and-docs/
description Versioning, changelog, documentation, README, and commit-signing rules preserved from the previous AGENTS.md.
keywords
agents
versioning
changelog
docs
commits
audience
team
enterprise
expertise_level
advanced
doc_owner specfact-cli
tracks
AGENTS.md
CHANGELOG.md
README.md
docs/**
pyproject.toml
setup.py
src/specfact_cli/__init__.py
sibling specfact-cli-internal wiki scripts (see below)
last_reviewed 2026-04-16
exempt false
exempt_reason
id agent-rules-release-commit-and-docs
always_load false
applies_when
finalization
release
documentation-update
priority 70
blocking false
user_interaction_required true
stop_conditions
version bump requested without confirmation
depends_on
agent-rules-index
agent-rules-quality-gates-and-review

Versioning

  • Keep version updates in sync across all four canonical version files: pyproject.toml, setup.py, src/__init__.py, and src/specfact_cli/__init__.py.
  • Automated check: Before tagging or publishing, run hatch run check-version-sources (or python scripts/check_version_sources.py). It exits non-zero with a clear diff if pyproject.toml, setup.py, src/__init__.py, and src/specfact_cli/__init__.py disagree. The Tests job in .github/workflows/pr-orchestrator.yml runs the same script so mismatches fail CI. Pre-commit runs it whenever a version file is staged (see the check-version-sources hook in .pre-commit-config.yaml and scripts/pre-commit-quality-checks.sh) instead of treating version-only commits as “safe” without verification.
  • PyPI ahead-of check: Run hatch run check-pypi-ahead (or python scripts/check_local_version_ahead_of_pypi.py without flags) for a strict compare to PyPI. CI and pre-commit pass --skip-when-version-unchanged-vs (merge base on PRs, previous commit on pushes, HEAD in pre-commit) so touching pyproject.toml for dependencies only does not query PyPI when project.version is unchanged; when the declared version does change relative to that revision, the check still requires local strictly greater than PyPI (matching .github/workflows/scripts/check-and-publish-pypi.sh). CI runs the step in the Tests job after check_version_sources, only when the PR changes canonical version files (pyproject.toml, setup.py, src/__init__.py, src/specfact_cli/__init__.py — same idea as the pre-commit hook’s files: filter). For offline work only, SPECFACT_SKIP_PYPI_VERSION_CHECK=1 skips the check (do not use in CI).
  • hatch run release is reserved for maintainers to chain check-version-sources before manual release steps; extend that script if you add more release automation.
  • feature/* branches imply a minor bump, bugfix/* and hotfix/* imply a patch bump, and major bumps require explicit confirmation.

Changelog

  • Update CHANGELOG.md in the same commit as the version bump.
  • Follow Keep a Changelog sections: Added, Changed, Fixed, Removed, Security.

Commits

  • Use Conventional Commits.
  • If signed commits fail in a non-interactive shell, stage files and hand the exact git commit -S -m "<message>" command to the user instead of bypassing signing.

Documentation and README

  • Keep docs current with every user-facing behavior change.
  • Preserve all Jekyll frontmatter on docs edits.
  • Update navigation when adding or moving pages.
  • Keep README.md and the docs landing page aligned with what SpecFact actually does.

Internal wiki (sibling specfact-cli-internal)

After merging changes that affect OpenSpec or GitHub-linked planning, and when a sibling specfact-cli-internal checkout is available, run the wiki scripts only after cd into that internal repo so the working directory matches what the scripts expect (running from specfact-cli or elsewhere will break them). From this repo’s root, for example:

cd ../specfact-cli-internal && python3 scripts/wiki_openspec_gh_status.py

If the change touched lots of docs frontmatter (especially under docs/agent-rules/), also run:

cd ../specfact-cli-internal && python3 scripts/wiki_rebuild_graph.py

When you materially edit an active OpenSpec change (scope, design, tasks story or dependencies), also update the mirrored wiki/sources/<change-id>.md in the sibling internal repo when it is available, then run wiki_rebuild_graph.py as in 40-openspec-and-tdd.md. If the internal checkout is missing, record a merge checklist or follow-up instead of assuming the wiki is current.

See Internal wiki maintenance under 40-openspec-and-tdd.md.