Skip to content

docs: clarify that committing .lock.yml is intentional in Quick Start #46562

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

docs: clarify that committing .lock.yml is intentional in Quick Start #46562

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
824f2e5
Initial plan
Copilot Jul 19, 2026
76b21a8
docs: add callout about committing both .md and .lock.yml in quick start
Copilot Jul 19, 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
5 changes: 4 additions & 1 deletion 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 @@ -165,7 +165,10 @@ To customize it now:
---
```

4. Commit and push to your repository.
> [!NOTE]
> Commit **both** files — the `.md` source and the generated `.lock.yml`. The lock file is intentional and required by GitHub Actions to run your workflow; committing a generated file here is correct.

4. Commit and push both files to your repository.

5. Optionally trigger another run by running:

Expand Down