Skip to content

Conversation

@github-actions
Copy link
Contributor

Documentation Updates - 2026-01-22

This PR updates the CLI documentation to reflect the safety features added to the --push flag in PR #11343.

Changes Made

Updated docs/src/content/docs/setup/cli.md to document the new safety features for --push flag across three commands:

gh aw init --push

  • Added remote repository requirement
  • Added default branch validation
  • Added user confirmation prompt (auto-confirmed in CI)
  • Reordered steps to reflect the actual execution flow
  • Added "Safety features" section highlighting the protections

gh aw run --push

  • Added remote repository requirement
  • Added branch validation (default branch or --ref branch)
  • Added user confirmation prompt (auto-confirmed in CI)
  • Reordered steps to reflect the actual execution flow
  • Added "Safety features" section highlighting the protections

gh aw upgrade --push

  • Added remote repository requirement
  • Added default branch validation
  • Added user confirmation prompt (auto-confirmed in CI)
  • Reordered steps to reflect the actual execution flow
  • Added "Safety features" section highlighting the protections

Safety Features Documented

The documentation now clearly explains that --push includes:

  • Remote repository requirement: Prevents errors when no remote is configured
  • Branch validation: Ensures pushes only happen on the default branch (prevents accidental pushes to feature branches)
  • User confirmation: Interactive prompt before mutating git operations (outside CI)
  • CI auto-confirmation: Automatic approval in CI environments (via CI, CONTINUOUS_INTEGRATION, GITHUB_ACTIONS env vars)

Merged PRs Referenced

Notes

All merged PRs from the last 24 hours were reviewed. Most already included documentation updates:

The only documentation gap was the --push flag safety features, which this PR addresses.

AI generated by Daily Documentation Updater

Updates CLI documentation to reflect the safety features added to the
--push flag in PR #11343:

- Remote repository requirement
- Default branch validation
- User confirmation prompt (auto-confirmed in CI)

Updated documentation for:
- gh aw init --push
- gh aw run --push
- gh aw upgrade --push

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 22, 2026
@pelikhan pelikhan merged commit ddf7962 into main Jan 22, 2026
@pelikhan pelikhan deleted the main-2c87ae8689fa410b branch January 22, 2026 18:07
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.

3 participants