Clarify .lock.yml purpose and edit model in Quick Start Step 2#35078
Merged
Conversation
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation to explain .lock.yml files in Quick Start Step 2
Clarify May 26, 2026
.lock.yml purpose and edit model in Quick Start Step 2
github-actions Bot
added a commit
that referenced
this pull request
May 27, 2026
…dit) - Bump spec version from 1.0.12 to 1.0.13 - Update Section 7.2 mapping audit to 2026-05-27 - Evaluated PRs #35005–#35078: all security-relevant changes covered by existing CTR rules or outside compiler threat detection scope - Add version 1.0.13 to Section 2 spec-to-implementation sync table - Add 1.0.13 changelog entry Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Quick Start Step 2 mentioned that
add-wizardcreates both.mdand.lock.ymlfiles but did not explain the lock file’s role or whether it should be edited. This left new users unclear about why two workflow files appear and which one is the source of truth.Docs: lock file mental model in onboarding path
setup/quick-start.mdx:.lock.ymlis the compiled GitHub Actions workflow generated from.md.md.lock.ymlshould be regenerated withgh aw compile, not edited manuallyDocs: direct reference for deeper details
/gh-aw/reference/workflow-structure/#lock-file-header