feat: user-friendly error if lock file missing#848
Merged
AtofStryker merged 1 commit intoMar 28, 2023
Conversation
lmiller1990
reviewed
Mar 23, 2023
lmiller1990
approved these changes
Mar 26, 2023
Contributor
|
@AtofStryker can I get a quick 👀 , thanks! |
1a0a6cd to
d13e488
Compare
AtofStryker
approved these changes
Mar 28, 2023
|
🎉 This PR is included in version 5.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
This PR catches the error condition of a missing package manager lock file and displays a user-friendly error message.
The action requires a lock file from
npm,pnpmoryarnin order to install dependencies and store the cache.BEFORE
The action fails showing an error message similar to the following:
This error message only mentions
package-lock.json(npm). It does not mention lock file names frompnpmoryarn, which are also supported.AFTER
An error message is shown in the action logs summary and action logs details similar to the following. This makes the error condition clearer and provides the hints necessary to remediate the error.
"Action failed. Missing package manager lockfile. Expecting one of package-lock.json (npm), pnpm-lock.yaml (pnpm) or yarn.lock (yarn) in working-directory /home/runner/work/github-action/github-action/examples/yarn-classic"
Summary
Detail