Skip to content

[docs] Update documentation for features from 2025-11-18 #4252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Nov 18, 2025
Merged

[docs] Update documentation for features from 2025-11-18 #4252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,21 +341,33 @@ Update workflows to their latest versions.
```bash wrap
gh aw update # Update all workflows with source field
gh aw update ci-doctor # Update specific workflow
gh aw update ci-doctor --merge # Update with 3-way merge (preserve changes)
gh aw update ci-doctor --major --force # Allow major version updates
gh aw update --dir custom/workflows # Update workflows in custom directory
```

**What it does:**
- Updates workflows based on `source` field format `owner/repo/path@ref`
- Performs 3-way merge preserving local changes
- Replaces local file with upstream version (default behavior)
- Semantic version tags update within the same major version
- Falls back to git commands when GitHub API authentication fails

**Options:**
- `--dir`: Specify workflow directory (defaults to `.github/workflows`)
- `--merge`: Perform 3-way merge to preserve local changes (creates conflict markers if needed)
- `--major`: Allow major version updates (breaking changes)
- `--force`: Force update even with conflicts

**Conflict handling:** When conflicts occur, diff3 markers are added and recompilation is skipped until resolved.
**Update Modes:**

| Mode | Behavior |
|------|----------|
| Default | Replaces local file with latest upstream version (no conflicts) |
| `--merge` | 3-way merge preserving local changes (may create conflict markers) |

**Authentication:** The update command works with public repositories without requiring GitHub authentication. When GitHub API calls fail due to missing or insufficient tokens, the command automatically falls back to git commands for downloading workflow content.

**Conflict handling:** When using `--merge` and conflicts occur, diff3 markers are added and recompilation is skipped until resolved.

### Advanced

Expand Down
Loading