skills.rest
txema-puch
txema-puchCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Scan git diffs and update core project documentation after releases.

1|Updated Mar 23, 2026
Search Tags:#automation#workflow#versioning#documentation#release#docs#git-diff
One-click install
npx skills add https://github.com/txema-puch/drone-ai-saturdays --skill document-release-txema-puch
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/txema-puch/drone-ai-saturdays/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/txema-puch/drone-ai-saturdays --skill document-release-txema-puch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from the actual shipped code. This Skill automates scanning diffs and aligning core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) with what was released, reducing drift and review toil.

Core Features & Use Cases

  • Auto-align release notes with README, ARCHITECTURE, and CLAUDE instructions.
  • Validate documentation across version bumps and changelog entries.
  • Reconcile cross-document references and ensure consistency before PR merge.

Quick Start

Run the document-release skill to scan diffs and update the project docs accordingly.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation in sync with shipped code changes?▼

Documentation drift is fixed by scanning git diffs and aligning core project docs like README.md, ARCHITECTURE.md, and CLAUDE.md with newly shipped features. This automated workflow ensures docs reflect actual changes before pull requests merge.

What's the best way to automate release notes and changelog updates?▼

Automating release notes involves validating version bumps and reconciling changelog entries against shipped diffs. This process applies stepwise validation to ensure contributor guidelines and project documentation stay consistent across releases.

Can I update multiple project documentation files from a single git diff?▼

Yes, multi-file updates are supported by scanning a git diff and applying necessary changes across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md simultaneously. This ensures cross-document references remain consistent.

Does post-ship documentation automation work with pull request workflows?▼

Post-ship documentation automation integrates directly into release workflows and pull requests. It scans shipped changes, aligns documentation, and logs telemetry for auditing before the PR merge.

Why does my README not match my latest release version?▼

A README not matching a release version happens when documentation drifts from shipped code. Scanning git diffs and applying stepwise validation against VERSION and CHANGELOG files resolves this inconsistency automatically.

What is document-release workflow validation?▼

Document-release workflow validation is the process of checking documentation consistency against version bumps and changelog entries. It scans diffs to align shipped changes with core docs and logs telemetry for auditing.

Related Skills

Explore More Content & Communication Skills→
pcaokhaipcaokhai

document-release

Reconcile project documentation with shipped state by scanning diffs.

Community
Advanced
LaPaGaYoLaPaGaYo

document-release

Sync README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

Community
Advanced
wangfeivwangfeiv

gstack/ship

Automate code integration, testing, versioning, changelog generation, and pull request creation.

Community
Advanced
apeejay-educationapeejay-education

document-release

Align documentation files with shipped changes after merges.

Official
Advanced