You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Code Quality] Add note in Quick Start: commit both .md and .lock.yml files #46504
The Quick Start docs mention the .lock.yml compiled file but do not clearly tell users that committing it is intentional and required. New users may be confused about whether to commit a generated file.
"Step 4 mentions 'the compiled workflow that GitHub Actions actually runs' and 'you never edit it by hand.' But there's no visual of what this file looks like or why it exists. A beginner will wonder if they accidentally committed a generated file and whether that's right."
Suggested Changes
In docs/src/content/docs/setup/quick-start.md, after the gh aw compile step, add a callout box:
"Yes, commit both the .md source and the .lock.yml — the lock file is intentional and required by GitHub Actions to run your workflow."
Optionally add a brief mention in the docs FAQ or glossary.
Activity