Skip to content

chore: add documentation enforcement CI#1

Open
benikigai wants to merge 1 commit intomainfrom
chore/docs-enforcement
Open

chore: add documentation enforcement CI#1
benikigai wants to merge 1 commit intomainfrom
chore/docs-enforcement

Conversation

@benikigai
Copy link
Copy Markdown
Owner

Summary

  • Adds .github/workflows/docs-check.yml — GitHub Actions workflow enforcing the IMPLEMENTATION_SPEC documentation standard
  • Fails PRs that modify source code without updating CHANGELOG.md
  • Verifies all 4 standard doc files exist (CLAUDE.md, AGENT.md, DEBUG.md, CHANGELOG.md)
  • Warns (doesn't fail) if DEBUG.md is not updated

Test plan

  • PR with source changes + no CHANGELOG.md → CI fails
  • PR with source changes + CHANGELOG.md → CI passes
  • Doc-only PR (only .md files) → CI passes (no CHANGELOG required)
  • Repo missing any of 4 standard files → CI fails

🤖 Generated with Claude Code

Adds GitHub Actions workflow that fails PRs missing CHANGELOG.md
updates when source code is modified. Also verifies all 4 standard
doc files (CLAUDE.md, AGENT.md, DEBUG.md, CHANGELOG.md) exist.

Part of IMPLEMENTATION_SPEC documentation standard rollout.
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agent-forge Ready Ready Preview, Comment Apr 7, 2026 10:32pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant