Add Documentation Maintenance as GitHub Action by Groenbech96 · Pull Request #7294 · microsoft/BCApps

Groenbech96 · 2026-03-20T10:33:46Z

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

Triggers on PRs that modify .al files under src/
Finds changed apps by walking up to nearest app.json
Runs copilot -p with al-docs skill per app (read/write/glob/grep only)
If docs were generated, opens a draft PR targeting the feature branch

AB#626091

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>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions · 2026-03-20T12:37:09Z

Documentation gaps detected

The following apps changed in this PR but have missing or incomplete documentation:

Data Archive (src/Apps/W1/DataArchive/App):

The DataArchive app has 3 tables, 4 codeunits, 4 pages, and 4 permission sets (15 .al files total) — no CLAUDE.md or docs/ directory exists. This is a moderately sized app with enough objects that structured documentation would help developers understand its archiving workflow. The developer should run al-docs to bootstrap documentation covering the data model, business logic, and extensibility surface.

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>

github-actions · 2026-03-20T12:40:31Z

Documentation gaps detected

The following apps changed in this PR but have missing or incomplete documentation:

Data Archive (src/Apps/W1/DataArchive/App):

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 al-docs would be worthwhile to generate structured documentation covering the data model, business logic, and extensibility points.

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>

github-actions · 2026-03-20T12:45:11Z

Documentation gaps detected

The following apps changed in this PR but have missing or incomplete documentation:

Data Archive (src/Apps/W1/DataArchive/App):

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 al-docs would be a good idea to bootstrap it.

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>

.github/workflows/PullRequestHandler.yaml

.github/workflows/DocumentationMaintenance.yaml

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>

.github/workflows/DocumentationMaintenance.yaml

github-actions · 2026-03-20T12:52:03Z

Documentation gaps detected

The following apps changed in this PR but have missing or incomplete documentation:

Data Archive (src/Apps/W1/DataArchive/App): | ≥1 specialized doc | src/docs/ | ❌ Missing |

Coverage: 0% (0 of 7 expected documentation files exist)

Total usage est: 3 Premium requests
API time spent: 1m 55s
Total session time: 2m 4s
Total code changes: +0 -0
Breakdown by AI model:
claude-opus-4.6 202.5k in, 4.0k out, 186.2k cached (Est. 3 Premium requests)
claude-haiku-4.5 102.6k in, 4.4k out, 91.4k cached (Est. 0 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>

github-actions · 2026-03-20T12:55:24Z

Documentation gaps detected

The following apps changed in this PR but have missing or incomplete documentation:

Data Archive (`src/Apps/W1/DataArchive/App`): 4. Run `/al-docs update`: After init, to set up the update baseline

Summary: The Data Archive app has 0% documentation coverage — none of the 6 expected doc files exist (app-level CLAUDE.md, data-model.md, business-logic.md, extensibility.md, plus subfolder src/ CLAUDE.md and at least one additional topic doc). The src/ subfolder scores 9/10 (MUST_DOCUMENT) due to 3 tables, 4 codeunits, event subscribers, and a complex provider codeunit. The developer should absolutely run /al-docs init to bootstrap the full documentation set from scratch.
Total usage est: 3 Premium requests
API time spent: 3m 31s
Total session time: 2m 43s
Total code changes: +0 -0
Breakdown by AI model:
claude-opus-4.6 137.6k in, 4.6k out, 105.7k cached (Est. 3 Premium requests)
claude-haiku-4.5 578.0k in, 14.4k out, 549.8k cached (Est. 0 Premium requests)

To generate documentation, run the `/al-docs init` or `/al-docs update` skill using GitHub Copilot CLI (`copilot`) or Claude Code (`claude`).

…-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>

github-actions · 2026-03-20T13:07:54Z

Documentation gaps detected

The following apps changed in this PR but have missing or incomplete documentation:

Data Archive (`src/Apps/W1/DataArchive/App`): 4. Run `/al-docs update`: After init, to set up the update baseline.

Audit summary: The Data Archive app has 0% documentation coverage — none of the 5 expected doc files exist (app-level CLAUDE.md, docs/data-model.md, docs/business-logic.md, plus subfolder-level src/docs/CLAUDE.md and one additional doc for the src/ module which scores 8/10 as MUST_DOCUMENT). The app is small (15 AL objects) but entirely undocumented, so the developer should run /al-docs init to bootstrap all missing files in one pass.
Total usage est: 3 Premium requests
API time spent: 4m 1s
Total session time: 3m 7s
Total code changes: +0 -0
Breakdown by AI model:
claude-opus-4.6 170.8k in, 5.9k out, 135.4k cached (Est. 3 Premium requests)
claude-haiku-4.5 484.6k in, 14.5k out, 440.6k cached (Est. 0 Premium requests)

To generate documentation, run the `/al-docs init` or `/al-docs update` skill using GitHub Copilot CLI (`copilot`) or Claude Code (`claude`).

- 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>

- 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

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).

Test

- 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>

The review comment body is now built from shell parsing of the structured audit report (app name, coverage %) instead of asking Copilot to compose the text. Copilot is still used only for the YES/NO decision on whether gaps exist. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Replace fragile grep/sed parsing of audit report markdown with a constrained copilot call that extracts just the coverage number. The response is further sanitized with grep -oE to ensure only a number+% makes it into the template. App name comes from the report filename (set from app.json during the audit step). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Adds manual trigger support so the workflow can be re-run on any PR with a skip-dedup flag to bypass the existing review check. Also resolves PR metadata (head/base SHA) from the API when dispatched manually since the pull_request event context is not available. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

This reverts commit 44df4b1.

Set the repo variable DOCS_SKIP_DEDUP=true to re-post the docs review even if one already exists on the PR. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions

AL Documentation Audit

Documentation gaps were detected in the following apps:

Troubleshoot-FA-Ledger-Entries: 50% documentation coverage

To generate documentation, run /al-docs init or /al-docs update using GitHub Copilot CLI or Claude Code.
This review is for awareness to help keep documentation in sync with code changes. It is okay to dismiss this request.

Rename the skip-dedup variable and change the review event from REQUEST_CHANGES to COMMENT so it doesn't block the PR. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove the paths filter on PullRequestHandler.yaml and revert the whitespace-only PermissionSet change. Add an XML doc comment to DataSearchResult.table.al so the docs workflow has an .al change to trigger on. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions

AL Documentation Audit

Documentation gaps were detected in the following apps:

Data-Search: 0% documentation coverage

To generate documentation, run /al-docs init or /al-docs update using GitHub Copilot CLI or Claude Code.
This review is for awareness to help keep documentation in sync with code changes. It is okay to dismiss this request.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

testing

tools/al-docs-plugin/.claude-plugin/plugin.json

tools/al-docs-plugin/skills/al-docs/references/al-scoring.md

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions bot added Build: Automation Workflows and other setup in .github folder AL: Apps (W1) Add-on apps for W1 labels Mar 20, 2026

Groenbech96 force-pushed the docs/documentation-maintenance-action branch from 2d5899e to add7ca8 Compare March 20, 2026 12:24

github-actions bot removed the AL: Apps (W1) Add-on apps for W1 label Mar 20, 2026

test: trigger docs workflow (revert before merge)

2accdbf

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions bot added the AL: Apps (W1) Add-on apps for W1 label Mar 20, 2026

fix: clarify how to run al-docs in PR comment

00cdc46

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: remove --allow-all-paths, copy skills into cwd instead

a467840

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: invoke al-docs audit skill instead of manual check

34eb5c7

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

aholstrup1 reviewed Mar 20, 2026

View reviewed changes

.github/workflows/PullRequestHandler.yaml Outdated Show resolved Hide resolved

.github/workflows/DocumentationMaintenance.yaml Outdated Show resolved Hide resolved

.github/workflows/DocumentationMaintenance.yaml Show resolved Hide resolved

fix: show full copilot output in CI log, extract summary for PR comment

026e490

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>

aholstrup1 reviewed Mar 20, 2026

View reviewed changes

.github/workflows/DocumentationMaintenance.yaml Outdated Show resolved Hide resolved

fix: trust plugin install folder via config.json instead of allow-all…

b01f4ad

…-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>

Magnus Hartvig Grønbech and others added 5 commits March 20, 2026 14:13

fix: allow shell(git:*) for audit staleness check

bebdfb0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: allow only shell(git log:*) for audit staleness check

a2cdb08

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: scope git log to read-only

3335584

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions bot previously requested changes Mar 20, 2026

View reviewed changes

Magnus Hartvig Grønbech and others added 2 commits March 20, 2026 14:47

simplify: remove second copilot call, use --share export directly

4db7068

- 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>

refactor: use conditional copilot check for review decision

86b9996

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>

Magnus Hartvig Grønbech and others added 5 commits March 23, 2026 10:08

Revert "Add workflow_dispatch with skip-dedup option"

22f6bf4

This reverts commit 44df4b1.

Add DOCS_SKIP_DEDUP variable to bypass existing review check

309be6c

Set the repo variable DOCS_SKIP_DEDUP=true to re-post the docs review even if one already exists on the PR. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions bot previously requested changes Mar 23, 2026

View reviewed changes

Magnus Hartvig Grønbech and others added 2 commits March 23, 2026 10:21

Rename variable to RUN_DOCS_CHECK_ON_EVERY_ITERATION, post as comment

8abefd6

Rename the skip-dedup variable and change the review event from REQUEST_CHANGES to COMMENT so it doesn't block the PR. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions bot reviewed Mar 23, 2026

View reviewed changes

Remove test AL change from DataSearch app

1662582

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions bot removed the AL: Apps (W1) Add-on apps for W1 label Mar 23, 2026

Groenbech96 marked this pull request as ready for review March 23, 2026 09:37

Groenbech96 requested review from a team as code owners March 23, 2026 09:37

Groenbech96 requested review from AleksandricMarko and removed request for AleksandricMarko March 23, 2026 09:37

github-actions bot added this to the Version 29.0 milestone Mar 23, 2026

aholstrup1 previously approved these changes Mar 23, 2026

View reviewed changes

mynjj previously approved these changes Mar 23, 2026

View reviewed changes

JesperSchulz reviewed Mar 23, 2026

View reviewed changes

tools/al-docs-plugin/.claude-plugin/plugin.json Outdated Show resolved Hide resolved

JesperSchulz reviewed Mar 23, 2026

View reviewed changes

tools/al-docs-plugin/skills/al-docs/references/al-scoring.md Show resolved Hide resolved

Rename plugin author from NAV Team to BC Application Team

b5f30f8

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Groenbech96 dismissed stale reviews from mynjj and aholstrup1 via b5f30f8 March 23, 2026 14:01

JesperSchulz approved these changes Mar 23, 2026

View reviewed changes

aholstrup1 approved these changes Mar 23, 2026

View reviewed changes

Groenbech96 enabled auto-merge (squash) March 23, 2026 15:01

Groenbech96 merged commit 8596d2b into main Mar 23, 2026
48 checks passed

Groenbech96 deleted the docs/documentation-maintenance-action branch March 23, 2026 17:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Documentation Maintenance as GitHub Action#7294

Add Documentation Maintenance as GitHub Action#7294
Groenbech96 merged 34 commits intomainfrom
docs/documentation-maintenance-action

Groenbech96 commented Mar 20, 2026 •

edited by github-actions bot

Loading

Uh oh!

github-actions bot commented Mar 20, 2026

Uh oh!

github-actions bot commented Mar 20, 2026

Uh oh!

github-actions bot commented Mar 20, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2026

Uh oh!

github-actions bot commented Mar 20, 2026

Uh oh!

github-actions bot commented Mar 20, 2026

Uh oh!

github-actions bot left a comment

Uh oh!

github-actions bot left a comment

Uh oh!

github-actions bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Groenbech96 commented Mar 20, 2026 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How it works

Uh oh!

github-actions bot commented Mar 20, 2026

Documentation gaps detected

Uh oh!

github-actions bot commented Mar 20, 2026

Documentation gaps detected

Uh oh!

github-actions bot commented Mar 20, 2026

Documentation gaps detected

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2026

Documentation gaps detected

Coverage: 0% (0 of 7 expected documentation files exist)

Uh oh!

github-actions bot commented Mar 20, 2026

Documentation gaps detected

Data Archive (src/Apps/W1/DataArchive/App): 4. Run /al-docs update: After init, to set up the update baseline

Uh oh!

github-actions bot commented Mar 20, 2026

Documentation gaps detected

Data Archive (src/Apps/W1/DataArchive/App): 4. Run /al-docs update: After init, to set up the update baseline.

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Groenbech96 commented Mar 20, 2026 •

edited by github-actions bot

Loading

Data Archive (`src/Apps/W1/DataArchive/App`): 4. Run `/al-docs update`: After init, to set up the update baseline

Data Archive (`src/Apps/W1/DataArchive/App`): 4. Run `/al-docs update`: After init, to set up the update baseline.