This directory contains automated workflows for the AIOX project.
File: quarterly-gap-audit.yml
Story: 3.25
Created: 2025-10-28
Automatically audits architecture gaps on a quarterly basis and generates trend reports with MCP adoption metrics.
- Automatic: Runs quarterly on Jan 1, Apr 1, Jul 1, Oct 1 at midnight UTC
- Manual: Can be triggered via GitHub Actions UI
- Parses framework entities (agents, tasks, templates, tools)
- Validates tool references (Story 3.21)
- Synthesizes relationships (Story 3.22)
- Detects gaps in the architecture
- Generates trend report with:
- Gap count comparison vs previous quarter
- Gap breakdown by category
- Top 10 entities with most gaps
- MCP adoption metrics (Docker MCP Toolkit)
- Token savings estimates
- Story suggestions for remediation
- Creates GitHub issue with the trend report
- Uploads artifacts for historical tracking
To manually run the audit:
- Go to Actions tab in GitHub
- Select Quarterly Architecture Gap Audit
- Click Run workflow
- Select branch (usually
main) - Click Run workflow button
The workflow will execute all steps and create a new issue with the audit results.
Each run creates artifacts:
gap-backlog.csv- Current gap backloggap-trend.json- Latest trend datagap-trend.md- Markdown reportgap-trend-history.json- Historical trend data
Download from the workflow run page under Artifacts section.
The workflow automatically creates a GitHub issue with:
- Title:
Q{1-4} {YEAR} Architecture Gap Audit - Labels:
architecture,gap-remediation,quarterly-audit - Body: Complete trend report with metrics and recommendations
The report includes Docker MCP Toolkit metrics:
- Tools via Docker gateway vs direct count
- Adoption rate percentage
- Token savings estimate
- MCP governance status
Note: Legacy 1MCP metrics have been deprecated. AIOX now uses Docker MCP Toolkit exclusively (Story 5.11).
Dependencies:
- Node.js 18
- npm packages (installed via
npm ci) - Architecture mapping scripts in
outputs/architecture-map/schemas/
Configuration:
- Edit assignees in workflow YAML if needed
- Adjust schedule by modifying cron expression
- Customize labels or issue template in workflow
Troubleshooting:
- Check workflow logs for errors
- Verify all parsing scripts exist
- Ensure gap-backlog.csv exists (run detect-gaps.js first)
File: pr-automation.yml
Story: 3.3-3.4
Created: 2025-12-02
Automates PR validation with coverage reporting, quality summary comments, and required status checks.
- Required Status Checks - Lint, TypeCheck, Tests, Story Validation
- Coverage Comments - Posts coverage report to PR
- Quality Summary - Generates quality gate summary comment
- CodeRabbit Integration - Verifies CodeRabbit configuration
| Job | Target | Timeout |
|---|---|---|
| lint | < 60s | 5 min |
| typecheck | < 60s | 5 min |
| test | < 2 min | 10 min |
| story-validation | < 30s | 5 min |
| Total (parallel) | < 3 min | - |
All main jobs run in parallel, achieving total PR validation time under 3 minutes.
These checks must pass before a PR can be merged to main:
# Required status checks
- lint
- typecheck
- test
- story-validation
- quality-summaryContinuous integration testing for push events and PRs.
Extended test suite with security audit, build validation, and compatibility testing.
Tests the framework across different operating systems.
Last Updated: 2025-12-02 (Story 3.3-3.4)