feat: Add GitHub Agentic Workflows for docs, testing, and CLI consistency#104
feat: Add GitHub Agentic Workflows for docs, testing, and CLI consistency#104danielmeppiel merged 11 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces three GitHub Agentic Workflows (gh-aw) that automate documentation maintenance, test improvement, and CLI consistency checking for the APM repository. These workflows use the gh-aw framework's markdown-based workflow syntax, which differs from standard GitHub Actions YAML format and requires compilation via gh aw compile before execution.
Changes:
- Adds daily-doc-updater.md to automatically sync documentation with code changes from merged PRs
- Adds daily-test-improver.md with 7 round-robin testing tasks and /test-assist command support
- Adds cli-consistency-checker.md to validate CLI help text against documentation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
.github/workflows/daily-doc-updater.md |
Scans last 24h of commits, identifies doc drift, creates PRs to update docs/ files while flagging README.md changes for human review |
.github/workflows/daily-test-improver.md |
Comprehensive testing assistant with command discovery, opportunity identification, test implementation, PR maintenance, and monthly reporting |
.github/workflows/cli-consistency-checker.md |
Validates all APM CLI commands by running --help, cross-referencing docs, and reporting inconsistencies via consolidated issues |
Comments suppressed due to low confidence (2)
.github/workflows/daily-test-improver.md:169
- The workflow references
src/AGENTS.mdwhich does not exist in the repository. AGENTS.md is a generated output file, not a source file. Consider removing this reference or replacing it with appropriate documentation files.
- Read `src/AGENTS.md` for any coding conventions or guidelines.
.github/workflows/daily-test-improver.md:267
- The workflow references
src/AGENTS.mdwhich does not exist in the repository. AGENTS.md is a generated output file, not a source file. Consider removing this reference or replacing it with appropriate documentation files.
- Read `src/AGENTS.md` before every run to stay aligned with project conventions.
…ency - gh aw init: .gitattributes, agent dispatcher, vscode settings - gh aw add: daily-doc-updater from githubnext/agentics gallery - gh aw add: daily-test-improver from githubnext/agentics gallery (fixed incompatible max fields in safe-outputs for current gh-aw version) - gh aw new + custom: cli-consistency-checker re-engineered for APM CLI - gh aw compile: all 3 workflows compiled with 0 errors, 0 warnings - Auto-generated agentics-maintenance.yml for expires field cleanup
573b3bc to
febf4da
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Sync agentic-workflows.agent.md with upstream gh-aw main: - Replace 'infer: false' with 'disable-model-invocation: true' - Update all prompt URLs from v0.42.2 to main - Add missing prompt routes: report, dependabot, test-coverage - Add single-file output note - Replace pip install with uv sync in cli-consistency-checker.md - Add auto-merge: true and reviewers: [copilot] to daily-doc-updater.md - Recompile lock files
- Recompile all lock files with --action-tag v0.50.5 - Update actions/setup pin in agentics-maintenance.yml - All 18 actions/setup references now at v0.50.5
Review Comment Resolution SummaryAfter thoroughly verifying all 22 review threads against the actual gh-aw documentation and source, here's what was done: Fixes Applied (2 commits)Commit
Commit
Review Comments Assessed as Non-Issues (with rationale)
VerdictPR is ready to merge. All legitimate issues from both human reviewers and Copilot reviewer have been addressed. The remaining unresolved threads are false positives from the automated reviewer not being familiar with gh-aw's domain-specific conventions. |
Summary
Adds 3 GitHub Agentic Workflows to automate documentation maintenance, test improvement, and CLI consistency checking.
All workflows were installed/created using the
gh awCLI and compiled withgh aw compile(0 errors, 0 warnings).Setup
gh aw init— initialized repo with.gitattributes, agent dispatcher (.github/agents/), and VS Code settingsgh aw compile— generated.lock.ymlfiles for all 3 workflowsWorkflows Added
1. Daily Documentation Updater
Installed via:
gh aw add githubnext/agentics/daily-doc-updaterdocs/directory[docs]prefix, auto-merge enabled2. Daily Test Improver
Installed via:
gh aw add githubnext/agentics/daily-test-improver/test-assistslash commandmaxfields insafe-outputsfor current gh-aw v0.42.23. CLI Consistency Checker (Custom)
Created via:
gh aw new cli-consistency-checker+ custom contentgh awcommands)--helpdocs/cli-reference.mdandREADME.mdFiles Added (10 files, ~4560 lines)
.gitattributesgh aw init.github/agents/agentic-workflows.agent.mdgh aw init.vscode/settings.jsongh aw init.github/workflows/daily-doc-updater.mdgh aw add(gallery).github/workflows/daily-doc-updater.lock.ymlgh aw compile.github/workflows/daily-test-improver.mdgh aw add(gallery).github/workflows/daily-test-improver.lock.ymlgh aw compile.github/workflows/cli-consistency-checker.mdgh aw new+ custom.github/workflows/cli-consistency-checker.lock.ymlgh aw compile.github/workflows/agentics-maintenance.ymlgh aw compile(auto-generated forexpiresfield cleanup)Security
All workflows use read-only default permissions with scoped
safe-outputsfor write operations. No write permissions are granted by default.Note on Secrets
gh aw initflagged thatGH_AW_GITHUB_TOKEN,GH_AW_AGENT_TOKEN, andGH_AW_GITHUB_MCP_SERVER_TOKENare not configured as repository secrets. These will need to be set up for the workflows to function in CI.