Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Jan 5, 2026

Documentation Updates - January 5, 2026

This PR updates the documentation based on the new --push flag feature merged in the last 24 hours.

Feature Documented

--push flag for gh aw run command (from PR #8971)

The --push flag provides an all-in-one workflow update and execution experience:

  • Auto-recompiles outdated .lock.yml files
  • Collects and stages all imported files recursively (transitive imports)
  • Shows interactive confirmation dialog before committing
  • Stages workflow .md and .lock.yml files plus dependencies
  • Creates commit with message "Updated agentic workflow"
  • Validates branch when used with --ref flag
  • Pushes changes to remote and triggers workflow dispatch

Changes Made

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

  • Added --push and --ref options to the run command documentation section
  • Added detailed subsection explaining --push flag functionality with 7 key features
  • Updated "Common Workflows for Beginners" section with --push example
  • Added code examples demonstrating --push usage patterns

Usage Examples

gh aw run workflow --push                   # Auto-commit, push, and dispatch
gh aw run workflow --push --ref main        # Push to specific branch

Merged PRs Referenced

Analysis Summary

Reviewed 30+ merged PRs from the last 24 hours. Most were internal refactoring, security fixes, or bug fixes that don't require user-facing documentation updates. PR #8956 (hourly schedule feature) was already documented in its own PR.

The --push flag is a significant user-facing feature that simplifies the workflow development cycle and was missing from the CLI documentation.

Documentation Standards

This update follows project documentation guidelines:

  • Uses neutral, technical tone
  • Provides clear, actionable examples
  • Uses proper markdown syntax
  • Includes numbered list for feature explanation
  • Maintains consistency with existing documentation style
  • Focuses on information-oriented reference documentation

AI generated by Daily Documentation Updater

Add documentation for the --push flag feature added in PR #8971.
This flag provides an all-in-one workflow update and execution experience
by automatically recompiling, staging, committing, pushing, and dispatching
workflows.

Changes:
- Add --push and --ref options to run command documentation
- Add detailed section explaining --push flag functionality
- Update beginner workflows section with --push example
- Add usage examples for common scenarios

Related: #8971
@pelikhan pelikhan marked this pull request as ready for review January 5, 2026 18:37
@pelikhan pelikhan merged commit 80b1cf5 into main Jan 5, 2026
4 checks passed
@pelikhan pelikhan deleted the docs/document-push-flag-2026-01-05-519c5664a980fe15 branch January 5, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants