Update Documentation for Lockfile #1454
Open
+22
−2
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to clarify how to use setup-node without a lockfile, addressing issue #928. The changes soften the recommendation language around lockfiles from absolute ("always") to advisory ("strongly recommended" and "Most"), and add a new section explaining how to properly configure the action when not using a lockfile.
Key changes:
- Modified the strength of lockfile recommendations from mandatory to advisory language
- Added a new "Running without a lockfile" subsection with clear instructions on disabling caching
- Updated the README table of contents to include the "Using private mirror" section
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/advanced-usage.md | Changed "All" to "Most" in lockfile recommendation, added new subsection documenting how to run without a lockfile with proper cache configuration |
| README.md | Softened lockfile recommendation from "always" to "strongly recommended", added missing TOC entry for private mirror section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
priya-kinthali
approved these changes
Dec 17, 2025
aparnajyothi-y
approved these changes
Dec 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description:
Updated the documentation to clarify how to run setup-node without a lockfile.
Related issue:
#928
Check list: