Skip to content

[docs] Update documentation for audit command deep URL support#8392

Merged
pelikhan merged 1 commit into
mainfrom
main-e9c9180e35ed2fbb
Jan 1, 2026
Merged

[docs] Update documentation for audit command deep URL support#8392
pelikhan merged 1 commit into
mainfrom
main-e9c9180e35ed2fbb

Conversation

@github-actions

@github-actions github-actions Bot commented Jan 1, 2026

Copy link
Copy Markdown
Contributor

Documentation Updates - 2026-01-01

This PR updates the documentation based on features merged in the last 24 hours.

Features Documented

Changes Made

  • Updated docs/src/content/docs/setup/cli.md:

    • Enhanced the troubleshooting section to explain all URL formats accepted by the audit command
    • Expanded the audit command reference section with detailed examples showing run IDs, workflow URLs, job URLs, and step-level URLs
    • Added explanation of automatic step extraction behavior (first failing step for job URLs, specific step for step URLs)
    • Added information about log file naming conventions
  • Updated docs/src/content/docs/setup/mcp-server.md:

    • Enhanced the audit tool description to mention support for run IDs, workflow run URLs, job URLs, and step-level URLs

Merged PRs Referenced

The audit command now supports multiple URL formats for more precise debugging:

  • Run IDs: 12345678
  • Workflow run URLs: https://github.com/owner/repo/actions/runs/123
  • Job URLs: https://github.com/owner/repo/actions/runs/123/job/456 (extracts first failing step)
  • Step URLs: https://github.com/owner/repo/actions/runs/123/job/456#step:7:1 (extracts specific step)

This enhancement makes it significantly easier to debug workflow failures by allowing users to paste URLs directly from GitHub Actions failure notifications.

Other PRs Analyzed

The following 19 PRs were also merged in the last 24 hours but contain internal refactoring, CI improvements, and code quality fixes that don't require user-facing documentation updates:

AI generated by Daily Documentation Updater

Document the new deep URL support for the audit command added in PR #8337.
The audit command now accepts job URLs and step-level URLs for precise
failure analysis.

Changes:
- Enhanced CLI documentation with examples of all URL formats
- Updated troubleshooting section with detailed URL usage
- Added MCP server documentation for audit tool URL support

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Jan 1, 2026
@pelikhan pelikhan merged commit 4db66c8 into main Jan 1, 2026
4 checks passed
@pelikhan pelikhan deleted the main-e9c9180e35ed2fbb branch January 1, 2026 00:34
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.

2 participants