Skip to content

[docs] Update documentation for features from 2026-02-28 #18894

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

Closed
github-actions wants to merge 2 commits into from
+15 −0
Closed

[docs] Update documentation for features from 2026-02-28 #18894

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f21091
docs: document checkout.github-token → checkout.token manual migration
github-actions[bot] Feb 28, 2026
d48a380
ci: trigger CI checks
github-actions[bot] Feb 28, 2026
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
15 changes: 15 additions & 0 deletions docs/src/content/docs/guides/upgrading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,21 @@ Review changes with `git diff .github/workflows/` to verify that deprecated fiel

Typical migrations include `sandbox: false` → `sandbox.agent: false`, `daily at` → `daily around`, and removal of deprecated `network.firewall` and `safe-inputs.mode` fields. Use `git diff --word-diff` for detailed comparison.

> [!NOTE]
> **Manual migration required: `checkout.github-token` → `checkout.token`**
>
> If your workflow uses `checkout.github-token:` in the frontmatter, rename the field to `checkout.token:`. This aligns the user-facing field name with the `token` input of `actions/checkout` and is not applied automatically by `gh aw fix`.
>
> ```yaml
> # Before (no longer valid)
> checkout:
> github-token: ${{ secrets.MY_TOKEN }}
>
> # After
> checkout:
> token: ${{ secrets.MY_TOKEN }}
> ```

## Step 5: Verify Compilation

The upgrade automatically compiles workflows. To validate specific workflows, run `gh aw compile my-workflow --validate`. Common issues include invalid YAML syntax, deprecated fields (fix with `gh aw fix --write`), or incorrect schedule format. See the [schedule syntax reference](/gh-aw/reference/schedule-syntax/) for details.
Expand Down