Skip to content

docs: add AGENTS.md to track project changes - #1

Draft
continue[bot] wants to merge 3 commits into
mainfrom
docs/add-agents-tracking
Draft

continue[bot] wants to merge 3 commits into
mainfrom
docs/add-agents-tracking

Conversation

@continue

@continue continue Bot commented Nov 19, 2025 •

Copy link
Copy Markdown

Summary

This PR adds AGENTS.md to document significant changes and implements automated changelog updates via GitHub Actions.

Changes

Documentation

  • Created AGENTS.md with comprehensive project documentation
  • Documented initial project setup from October 2025
  • Detailed architecture overview (scanner, generator, CLI, templates)
  • Listed all core features and capabilities
  • Outlined development workflow and extension points
  • Included roadmap for planned enhancements

Automation

  • Created GitHub Action (.github/workflows/update-agents.yml) to auto-update AGENTS.md
  • Implemented Node.js script (.github/scripts/update-agents.mjs) that:
    • Parses commit messages using Conventional Commits format
    • Filters significant commits (feat, fix, refactor, perf, breaking)
    • Extracts key changes from commit body and files
    • Organizes entries by month with commit hash and date
    • Updates AGENTS.md and commits changes automatically
  • Added documentation for automation scripts

How the automation works

  1. Triggers on every push to main branch
  2. Analyzes commit type and changed files
  3. Skips non-significant commits (chore, style, etc.)
  4. Extracts changes from commit body or infers from files
  5. Adds formatted entry to current month section in AGENTS.md
  6. Updates timestamp and commits back to repository

Benefits

  • Automatic tracking of all significant changes
  • Historical context for project evolution
  • Reduced manual work maintaining changelog
  • Consistent formatting across all entries
  • Better contributor visibility into project changes

Testing

Tested locally with:

node .github/scripts/update-agents.mjs <commit-hash>

The script correctly:

  • Identifies significant vs non-significant commits
  • Parses conventional commit formats
  • Extracts changes from body and files
  • Updates AGENTS.md with proper formatting
  • Skips self-referential updates

This agent session was co-authored by frpboy12 and Continue.

continue Bot and others added 3 commits November 19, 2025 09:05
- Document initial project setup from Oct 2025
- Detail architecture: scanner, generator, CLI, templates
- List core features and capabilities
- Outline development workflow and extension points
- Include roadmap for future enhancements

Co-authored-by: frpboy12 <frpboy12@gmail.com>
Generated with [Continue](https://continue.dev)

Co-Authored-By: Continue <noreply@continue.dev>
- Created GitHub Action to auto-update AGENTS.md on significant commits
- Implemented Node.js script to parse commits and extract changes
- Filters for feat, fix, refactor, perf, and breaking changes
- Organizes entries by month with commit hash and date
- Automatically commits changes back to repository
- Added documentation for automation scripts

Co-authored-by: frpboy12 <frpboy12@gmail.com>
Generated with [Continue](https://continue.dev)

Co-Authored-By: Continue <noreply@continue.dev>
- Created AUTOMATION.md explaining all workflows
- Documented update script functions and logic
- Added best practices for commit messages
- Included troubleshooting guide

Co-authored-by: frpboy12 <frpboy12@gmail.com>
Generated with [Continue](https://continue.dev)

Co-Authored-By: Continue <noreply@continue.dev>
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.

0 participants