Skip to content

Clarify .lock.yml purpose and edit model in Quick Start Step 2 #35078

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 2 commits into from
May 27, 2026
+2 −0
Merged

Clarify .lock.yml purpose and edit model in Quick Start Step 2 #35078

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa969fa
Initial plan
Copilot May 26, 2026
d1c793f
docs: explain .lock.yml in quick start step 2
Copilot May 26, 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
2 changes: 2 additions & 0 deletions docs/src/content/docs/setup/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ This will take you through an interactive process to:
4. **Add the workflow** - Adds the workflow file (`.md`) and its generated GitHub Actions lock file (`.lock.yml`) to `.github/workflows/`.
5. **Optionally trigger an initial run** - Starts the workflow immediately.

The `.lock.yml` file is the compiled GitHub Actions workflow generated from the `.md` source file. Keep editing the `.md` file; the lock file exists so GitHub Actions has a deterministic, runnable workflow definition. Do not edit `.lock.yml` directly — regenerate it with `gh aw compile` after making workflow changes. See [Lock File Header](/gh-aw/reference/workflow-structure/#lock-file-header).

> [!NOTE]
> **Setting up `COPILOT_GITHUB_TOKEN`?**
> 1. [Create a fine-grained PAT](https://github.com/settings/personal-access-tokens/new) under your user account.
Expand Down
Loading