pre-push-validation

Validate CLAUDE.md, README.md, and CHANGELOG.md updates before git push.

2|Updated Feb 22, 2024

Search Tags:#automation #git #documentation #validation #quality #push

Ready to run

npx skills add https://github.com/ddttom/allaboutv2 --skill pre-push-validation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pre-push-validation
Source: https://github.com/ddttom/allaboutv2/tree/main/.claude/skills/pre-push-validation
Command: npx skills add https://github.com/ddttom/allaboutv2 --skill pre-push-validation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents the common problem of pushing code changes without updating critical documentation, ensuring your project's documentation stays current with development.

Core Features & Use Cases

Automatic Git Hook Validation: Runs before every git push to check documentation freshness
Multi-File Monitoring: Validates CLAUDE.md, README.md, and CHANGELOG.md against code changes
Use Case: When you're about to push 3 commits with new features, the hook automatically checks if your documentation files have been updated since your oldest unpushed commit, preventing incomplete documentation pushes.

Quick Start

Use the pre-push-validation skill to check if my documentation is up to date before pushing these changes.

Frequently Asked Questions about pre-push-validation

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

FAQPage Schema

How do I prevent pushing code without updating documentation?▼

Pre-push validation automatically checks if your critical documentation files—CLAUDE.md, README.md, and CHANGELOG.md—have been updated since your oldest unpushed commit. If they haven't, it blocks the push until documentation is current.

What documentation files does pre-push validation check?▼

Pre-push validation monitors three files: CLAUDE.md for AI instructions and project context, README.md for project overview, and CHANGELOG.md for tracking changes. It verifies each has been updated relative to your unpushed commits.

Can I use pre-push validation as a git hook?▼

Yes, pre-push validation runs automatically as a git hook before every push. It detects uncommitted changes and validates file recency without requiring manual checks.

How does pre-push validation detect outdated documentation?▼

Pre-push validation compares the modification timestamps of CLAUDE.md, README.md, and CHANGELOG.md against your oldest unpushed commit. If documentation hasn't been updated since that commit, the hook flags it as outdated and prevents the push.

What happens if I try to push without updating docs?▼

Pre-push validation blocks the push and alerts you that documentation is outdated relative to your code changes. You must update the relevant files and commit them before the push succeeds.

Does pre-push validation work with multiple unpushed commits?▼

Yes, pre-push validation checks all unpushed commits in your current branch. It identifies the oldest unpushed commit and ensures documentation has been refreshed since that point to reflect all pending changes.