Skip to content

[docs] Update documentation for features from 2025-11-26#4805

Merged
pelikhan merged 1 commit intomainfrom
main-b86f5a7342e903a9
Nov 26, 2025
Merged

[docs] Update documentation for features from 2025-11-26#4805
pelikhan merged 1 commit intomainfrom
main-b86f5a7342e903a9

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Updates - November 26, 2025

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

Features Documented

  1. CLI --ref flag (from Add --ref flag to gh aw status and rename --branch to --ref in gh aw logs #4776)

    • Added --ref flag documentation to gh aw status command
    • Added --ref flag documentation to gh aw logs command
    • Shows latest run status and conclusion when filtering by branch or tag
  2. Import safe-outputs from shared workflows (from Add support for importing safe-outputs from shared agentic workflows #4761, Add support for importing safe-outputs.jobs from shared workflows #4782)

    • Documented ability to import safe-outputs: configurations from shared workflows
    • Documented safe output jobs import support
    • Explained conflict detection behavior
    • Added example showing safe output meta fields precedence
  3. Custom job outputs support (from Merge release.yml with release-highlights.md and add outputs support for custom jobs #4778)

    • Documented how custom jobs can expose outputs
    • Added example showing output definition and usage in agent prompts
    • Noted string value requirement for outputs

Changes Made

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

    • Updated status command section with --ref flag examples and description
    • Updated logs command section with --ref flag examples and description
  • docs/src/content/docs/reference/imports.md

    • Added safe-outputs: to list of mergeable frontmatter fields
    • Added new "Safe Outputs" subsection with comprehensive examples
    • Documented safe output jobs import support
    • Explained meta field precedence rules
  • docs/src/content/docs/reference/frontmatter.md

    • Added "Job Outputs" subsection under Custom Jobs section
    • Provided example of job output definition and usage
    • Noted string value requirement

Merged PRs Referenced

Notes

All documentation follows the Diátaxis framework and project documentation guidelines. Changes are concise, technically accurate, and include practical examples.

🤖 Generated with Claude Code

AI generated by Daily Documentation Updater

Updates documentation for three major features merged in the last 24 hours:

1. CLI --ref flag (#4776)
   - Add --ref flag to gh aw status command
   - Add --ref flag to gh aw logs command
   - Shows latest run status when filtering by branch/tag

2. Import safe-outputs from shared workflows (#4761, #4782)
   - Document safe-outputs importing capability
   - Document safe output jobs import support
   - Explain conflict detection and meta field precedence

3. Custom job outputs support (#4778)
   - Document job output definition syntax
   - Show usage in agent prompts with needs context
   - Note string value requirement

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

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Nov 26, 2025
@pelikhan pelikhan merged commit 4e9bece into main Nov 26, 2025
4 checks passed
@pelikhan pelikhan deleted the main-b86f5a7342e903a9 branch November 26, 2025 04:22
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