Switch to npm ci in the pipeline to avoid failures
#172
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
Replace, in workflow and project build files, npm install with npm ci, unless the npm install is a global installation. This solves unexpected pipeline failures and provides information on which dependencies need to be added, if any.
mikeisen1
requested review from
rgauss,
kylelaker,
hreineck and
snorouzzadeh
rgauss
suggested changes
Oct 1, 2021
README.md
Outdated
| @@ -29,7 +29,7 @@ The [example](./example) folder shows how those components can be assembled to c | |||
| ### Building and Running Locally | |||
|
|
|||
| In order to use the library components or test the library locally, the project components need to be rolled up and | |||
| dependencies need to be installed initially with the command: `npm install`. From here the application can be built | |||
There was a problem hiding this comment.
I don't think we want to change this for developers building locally, just the pipeline(s)
package.json
Outdated
| "eject": "react-scripts eject", | ||
| "lint": "npx eslint src/**/*.js --fix", | ||
| "format": "prettier --write src/**/*.js", | ||
| "deploy": "gh-pages -d oscal-react-library/build", | ||
| "build-library-and-run-example": "npm install && cd example && npm install && npm start", | ||
| "build-and-run-example": "cd example && npm install && npm start", | ||
| "build-library-and-run-example": "npm ci && cd example && npm ci && npm start", |
There was a problem hiding this comment.
Here as well, these are used by developers so I don't think they'd be changing.
Revert some changes made in package.json that used npm ci instead of npm install because those scripts were only used by developers and not in an actual workflow run
hreineck
approved these changes
Oct 1, 2021
rgauss
approved these changes
Oct 1, 2021
kylelaker
approved these changes
Oct 1, 2021
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.
Replace
npm installin the pipeline withnpm ci. We are doing this to avoid pipeline failures caused bynpm installmodifyingpackage-lock.json.npm ciwill not modify that file and it also provides more detailed messaging when a dependency error arises during a workflow run.