docs: add install-command lock file prerequisite #1310
Merged
Conversation
This file contains 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
|
This comment was marked as outdated.
This comment was marked as outdated.
AtofStryker
approved these changes
Nov 18, 2024
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.
Issue
The README section Custom install command shows only the example
install-command: yarn --frozen-lockfile --silentas a slightly modified Yarn Classic v1 install command.It does not specify that the action expects to find a lock file.
Change
Link to the Notes > Installation section which explains the relationship between lock files and the default installation command that the action uses.
Add the information that if no lock file is provided, then the workflow must ensure that dependencies are installed prior to using the action, and that the action must be called in this case with the option
install: false.