Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-04-07#25098

Merged
pelikhan merged 1 commit intomainfrom
doc-healer/remove-audit-report-from-cli-2026-04-07-e69caa9145c10ca3
Apr 7, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-04-07#25098
pelikhan merged 1 commit intomainfrom
doc-healer/remove-audit-report-from-cli-2026-04-07-e69caa9145c10ca3

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Apr 7, 2026

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

  • Issue [cli-consistency] CLI Consistency Issues - 2026-04-06 #24895[cli-consistency] CLI Consistency Issues - 2026-04-06: audit report is documented in docs/src/content/docs/setup/cli.md but the subcommand was removed in v0.66.1. Replaced the stale 13-line section with a compact migration callout pointing users to gh aw logs --format.

Root Cause

PR #24396 (feat: merge 'gh aw audit report' into 'gh aw logs --format') was merged on 2026-04-03 at 23:13 UTC — after DDUw's daily 6 AM UTC run had already completed. The PR correctly updated audit.md, glossary.md, cost-management.md, and the blog post, but did not update cli.md. DDUw's next run (2026-04-04, PR #24574) scanned the same-day merged PRs and missed PR #24396 because it fell outside the analysis window. The 2026-04-05, 2026-04-06, and 2026-04-07 DDUw runs also missed it.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

Pattern: When a PR removes a CLI subcommand, cli.md must be updated. The current Step 2 heuristic checks for "Features Removed" in merged PRs but does not cross-reference the removal against docs/src/content/docs/setup/cli.md for subcommand headings.

Specific Step 2 addition: After identifying a "Features Removed" PR, scan cli.md for headings (#####) matching the removed command name. If found, flag for removal or replacement with a migration callout. This check can run via:

grep -n "##### \`audit report\`" docs/src/content/docs/setup/cli.md

Why DDUw missed this: The PR landed 17 hours after DDUw's daily run closed. DDUw's current scan window is "last 24 hours of merged PRs," which should have caught this on the 2026-04-04 cycle — but DDUw focused on PR #24544 and #24495 from that day and did not also check PR #24396 (merged 2026-04-03 at 23:13 UTC), which was likely just outside the scan window boundary.

Improved boundary check: DDUw should extend its look-back window to 48 hours on the first run after a weekend or holiday, and should explicitly scan all commits touching pkg/cli/ for subcommand additions/removals, then cross-reference against cli.md headings.

Related Issues

References:

Note

🔒 Integrity filter blocked 1 item

The following item were blocked because they don't meet the GitHub integrity level.

  • #20207 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Daily Documentation Healer · ● 491.5K ·

  • expires on Apr 10, 2026, 1:31 PM UTC

The 'gh aw audit report' subcommand was removed in v0.66.1 (PR #24396).
Replace the stale documentation section with a callout note that directs
users to the replacement: 'gh aw logs --format'.
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Apr 7, 2026
@pelikhan pelikhan marked this pull request as ready for review April 7, 2026 13:54
Copilot AI review requested due to automatic review settings April 7, 2026 13:54
@pelikhan pelikhan merged commit 49672fd into main Apr 7, 2026
1 check passed
@pelikhan pelikhan deleted the doc-healer/remove-audit-report-from-cli-2026-04-07-e69caa9145c10ca3 branch April 7, 2026 13:54
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the CLI setup documentation to remove references to the deprecated gh aw audit report subcommand and guide users to the replacement cross-run reporting flow via gh aw logs --format.

Changes:

  • Replaced the removed audit report section with a migration callout pointing to gh aw logs --format.
  • Added updated example commands for generating cross-run reports (markdown/pretty/JSON).
  • Added a link to the audit reference documentation for the full command reference.
Show a summary per file
File Description
docs/src/content/docs/setup/cli.md Removes stale audit report docs and adds migration guidance to gh aw logs --format

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 2

##### `audit report`

Generate a comprehensive cross-run security audit report by aggregating firewall data across multiple recent runs. Designed for security reviews, compliance checks, and feeding debugging or optimization agents.
:::note[Cross-run security reports (`audit report` removed in v0.66.1)]
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file uses GitHub-style admonitions (> [!NOTE] at e.g. lines 107 and 324), but this new callout uses the :::note[...] syntax. For consistency within cli.md (and the setup/ docs), consider switching this block to the same > [!NOTE] format (or update the rest of the file to use ::: consistently).

See below for a potential fix:

> [!NOTE]
> **Cross-run security reports (`audit report` removed in v0.66.1)**
>
> Cross-run security and performance reports are now generated by `gh aw logs --format`. Use `--count` or `--last` to control the number of runs analyzed.
>
> ```bash wrap
> gh aw logs --format markdown                               # Report on recent runs (default: last 10)
> gh aw logs agent-task --format markdown --count 10         # Last 10 runs of a workflow
> gh aw logs agent-task --format markdown --last 5 --json    # JSON output
> gh aw logs --format pretty                                 # Console-formatted output
> gh aw logs --format markdown --repo owner/repo --count 10  # Specify repository
> ```
>
> See [Audit Commands](/gh-aw/reference/audit/) for the full reference.

Copilot uses AI. Check for mistakes.

Generate a comprehensive cross-run security audit report by aggregating firewall data across multiple recent runs. Designed for security reviews, compliance checks, and feeding debugging or optimization agents.
:::note[Cross-run security reports (`audit report` removed in v0.66.1)]
Cross-run security and performance reports are now generated by `gh aw logs --format`. Use `--count` or `--last` to control the number of runs analyzed.
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence references gh aw logs --format without specifying a required value. Since --format is a string flag, running it without an argument will error; consider writing this as gh aw logs --format {markdown|pretty} (or similar) to make the required value explicit.

Suggested change
Cross-run security and performance reports are now generated by `gh aw logs --format`. Use `--count` or `--last` to control the number of runs analyzed.
Cross-run security and performance reports are now generated by `gh aw logs --format {markdown|pretty}`. Use `--count` or `--last` to control the number of runs analyzed.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] CLI Consistency Issues - 2026-04-06

2 participants