Skip to content

[docs] Update documentation for features from 2026-04-04#24574

Merged
pelikhan merged 1 commit intomainfrom
docs/update-audit-diff-and-lockfile-header-2026-04-04-276a191ffcbcd6e1
Apr 4, 2026
Merged

[docs] Update documentation for features from 2026-04-04#24574
pelikhan merged 1 commit intomainfrom
docs/update-audit-diff-and-lockfile-header-2026-04-04-276a191ffcbcd6e1

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

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

Documentation Updates - 2026-04-04

This PR updates the documentation based on features merged today.

Features Documented

📝 Detailed Changes & References

Changes Made

  • Updated docs/src/content/docs/reference/audit.md:

    • Changed audit diff signature from <run-id-1> <run-id-2> to <base-run-id> <comparison-run-id> [<comparison-run-id>...]
    • Added note that the base run is downloaded once and reused for multiple comparisons
    • Extended diff output list to include token usage breakdown (input/output/cache tokens, effective tokens, API requests, cache efficiency)
    • Documented JSON array output and divider behavior when multiple comparison runs are provided
    • Added multi-run example: gh aw audit diff 12345 12346 12347 12348
  • Updated docs/src/content/docs/reference/workflow-structure.md:

    • Added "Lock File Header" subsection documenting the new manifest format
    • Documents gh-aw-metadata as the first line (machine-readable, reliable parsing)
    • Documents # Secrets used: and # Custom actions used: sections with an annotated example

Merged PRs Referenced

Notes

Generated by Daily Documentation Updater · ● 295.4K ·

  • expires on Apr 5, 2026, 8:31 PM UTC

- Update gh aw audit diff signature to reflect multi-run support:
  accepts one base run and one or more comparison runs (from #24544)
- Document token usage diff breakdown (input/output/cache tokens,
  API requests, cache efficiency) added in #24544
- Document JSON array output and divider behavior for multiple diffs
- Add lock file header section to workflow-structure.md documenting
  the gh-aw-metadata first-line placement and the Secrets/Custom
  actions manifest sections added in #24495

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Apr 4, 2026
@pelikhan pelikhan merged commit 8c6b8fc into main Apr 4, 2026
@pelikhan pelikhan deleted the docs/update-audit-diff-and-lockfile-header-2026-04-04-276a191ffcbcd6e1 branch April 4, 2026 20:58
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.

1 participant