Add Documentation Maintenance as GitHub Action#7294
Add Documentation Maintenance as GitHub Action#7294Groenbech96 wants to merge 24 commits intomainfrom
Conversation
github-actions
bot
added
the
Build: Automation
|
Could not find a linked ADO work item. Please link one by using the pattern 'AB#' followed by the relevant work item number. You may use the 'Fixes' keyword to automatically resolve the work item when the pull request is merged. E.g. 'Fixes AB#1234' |
Runs Copilot CLI with Claude Opus 4.6 and the al-docs plugin on PRs. Audits documentation coverage for changed AL apps and posts a summary as a PR comment suggesting to run al-docs if gaps are found. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Groenbech96
force-pushed
the
docs/documentation-maintenance-action
branch
from
2d5899e to
add7ca8
Compare
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation gaps detectedThe following apps changed in this PR but have missing or incomplete documentation: Data Archive ( The DataArchive app has 3 tables, 4 codeunits, 4 pages, and 4 permission sets (15 The user asked me to check the DataArchive app and reply in 2-3 sentences. I've already provided that answer. This was a research/information question, not a code change task. Consider running `/al-docs init` or `/al-docs update` on these apps to generate documentation before merging. |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation gaps detectedThe following apps changed in this PR but have missing or incomplete documentation: Data Archive ( The DataArchive app contains 15 AL objects: 3 tables, 4 codeunits (including 4 permission sets), and 4 pages — a modest but non-trivial extension. There is no CLAUDE.md or docs/ directory present. Given the app has multiple object types with archiving/export logic, running To generate documentation, run the `/al-docs init` or `/al-docs update` skill using GitHub Copilot CLI (`copilot`) or Claude Code (`claude`). |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation gaps detectedThe following apps changed in this PR but have missing or incomplete documentation: Data Archive ( The DataArchive app has 15 AL files: 3 tables, 4 pages, 4 codeunits, and 4 permission sets. There is no CLAUDE.md and no docs/ directory. If the developer wants structured documentation covering the data model, business logic, and extensibility of this app, running To generate documentation, run the `/al-docs init` or `/al-docs update` skill using GitHub Copilot CLI (`copilot`) or Claude Code (`claude`). |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
| on: | ||
| pull_request: | ||
| branches: [ 'main', 'releases/*', 'features/*' ] | ||
| paths: ['THIS_PR_IS_TESTING_DOCS_WORKFLOW_ONLY'] |
There was a problem hiding this comment.
This needs to be removed
Removes -s flag so tool traces are visible in Actions log. Filters out trace characters for the PR comment. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation gaps detectedThe following apps changed in this PR but have missing or incomplete documentation: Data Archive ( Coverage: 0% (0 of 7 expected documentation files exist)Total usage est: 3 Premium requests To generate documentation, run the `/al-docs init` or `/al-docs update` skill using GitHub Copilot CLI (`copilot`) or Claude Code (`claude`). |
Plugin install puts files in ~/.copilot/ which is outside the allowed path. Instead, reference the skill files directly from the checked-out tools/ directory. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation gaps detectedThe following apps changed in this PR but have missing or incomplete documentation: Data Archive (
|
…-paths Writes the plugin directory to ~/.copilot/config.json trusted_folders so copilot can read skill files without opening all paths. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation gaps detectedThe following apps changed in this PR but have missing or incomplete documentation: Data Archive (
|
- Strips usage stats and model traces from output - Posts as a review requiring dismissal, not a regular comment - Only posts when documentation gaps are found Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Copilot exports full session to markdown via --share - CI logs use ::group:: for collapsible per-app output - Second lightweight copilot call extracts clean summary from export - No more grep/sed parsing of stdout Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
The following apps changed in this PR have missing or incomplete documentation:
Data Archive ()
I’m pulling just the tail of the audit so I can extract the exact concluding summary and nothing else.
Coverage is 0% — zero documentation files exist out of 5 expected. What's missing: app-level , , , plus subfolder-level and at least one additional doc for . The developer should absolutely run — this is a greenfield documentation situation with 0% coverage, and the tool would bootstrap all 5 required files automatically.
To generate documentation, run the /al-docs init or /al-docs update skill using GitHub Copilot CLI (copilot) or Claude Code (claude).
- Timeout 600s, simplified prompt - Remove ::group::, remove summary extraction call - Just use the --share markdown export as the report Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
YES/NO check on the audit export decides whether to post a review. If yes, a second call generates a clean summary for the review body. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
I’m skimming the generated report structure first, then I’ll condense the documentation gaps into a short PR-ready note.
I found the session log; now I’m extracting just the audit result lines so the final review body names the affected apps and missing docs precisely.
src/Apps/W1/DataArchive/App: 0% documentation coverage; missing app-level CLAUDE.md, docs/data-model.md, and docs/business-logic.md.
Also missing subfolder docs for src/ (scored MUST_DOCUMENT): src/docs/CLAUDE.md plus at least one supplementary doc (data-model.md or business-logic.md).
To generate documentation, run the /al-docs init or /al-docs update skill using GitHub Copilot CLI (copilot) or Claude Code (claude).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Data Archive (src/Apps/W1/DataArchive/App): 0%, missing CLAUDE.md, docs/data-model.md, docs/business-logic.md, docs/extensibility.md, src/docs/CLAUDE.md, src/docs/{data-model|business-logic|extensibility|patterns}.md.
Data Search (src/Apps/W1/DataSearch/App): 0%, missing CLAUDE.md, docs/data-model.md, docs/business-logic.md, docs/extensibility.md, docs/patterns.md.
To generate documentation, run the /al-docs init or /al-docs update skill using GitHub Copilot CLI or Claude Code.
…ew prompt Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
AL Documentation Audit:
I reviewed the changed apps and found:
Troubleshoot FA Ledger Entries (src/Apps/W1/DataCorrectionFA/App): 0% documentation coverage
To generate documentation, run the /al-docs init or /al-docs update skill using GitHub Copilot CLI or Claude Code.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
AL Documentation Audit:
I reviewed the changed apps and found:
Troubleshoot FA Ledger Entries (src/Apps/W1/DataCorrectionFA/App): 50% documentation coverage
To generate documentation, run the /al-docs init or /al-docs update skill using GitHub Copilot CLI or Claude Code.
Checks for existing review starting with "AL Documentation Audit" before posting a new one. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Saves runner time and copilot API calls on repeated pushes. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Groenbech96
changed the title
2 participants
Summary
Adds a GitHub Action that runs Copilot CLI with the al-docs plugin on PRs to auto-generate documentation for changed AL apps.
How it works
.alfiles undersrc/app.jsoncopilot -pwith al-docs skill per app (read/write/glob/grep only)Prerequisites
COPILOT_PAT— PAT with "Copilot Requests" +reposcope