Skip to content

Clarify Quick Start terminology for frontmatter and .lock.yml #44079

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
Jul 7, 2026
Merged

Clarify Quick Start terminology for frontmatter and .lock.yml #44079

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0e0bbe
Initial plan
Copilot Jul 7, 2026
73cedbb
Clarify Quick Start frontmatter and lock file terms
Copilot Jul 7, 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
4 changes: 2 additions & 2 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,14 +72,14 @@ gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude
> [!IMPORTANT]
> Passing `--engine claude` pre-selects Claude and skips the interactive engine-selection step (Step 2 below).
> If you omit the flag, the wizard will ask you to choose.
> Note: if `engine:` is later removed manually from the workflow frontmatter (the YAML configuration block between the `---` markers at the top of the file), the runtime defaults to Copilot.
> Note: if `engine:` is later removed manually from the workflow frontmatter (the settings block at the top of the file, between the `---` lines), the runtime defaults to Copilot.

This will take you through an interactive process to:

1. **Check prerequisites** - Verify repository permissions.
2. **Select an AI Engine** - Choose between Copilot, Claude, Codex, or Gemini.
3. **Set up the required secret** - [`COPILOT_GITHUB_TOKEN`](/gh-aw/reference/auth/#copilot_github_token) (a separate GitHub token with Copilot access — distinct from the default `GITHUB_TOKEN`), [`ANTHROPIC_API_KEY`](/gh-aw/reference/auth/#anthropic_api_key), [`OPENAI_API_KEY`](/gh-aw/reference/auth/#openai_api_key), or [`GEMINI_API_KEY`](/gh-aw/reference/auth/#gemini_api_key). See [Authentication](/gh-aw/reference/auth/) for setup instructions.
4. **Add the workflow** - Adds the workflow file (`.md`) and its generated GitHub Actions lock file (`.lock.yml`) to `.github/workflows/`.
4. **Add the workflow** - Adds the workflow file (`.md`) and its generated GitHub Actions lock file (`.lock.yml`, the compiled workflow that GitHub Actions actually runs) to `.github/workflows/`.
5. **Optionally trigger an initial run** - Starts the workflow immediately.

> [!NOTE]
Expand Down