Skip to content
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.

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

Should package-lock.json be include? #739

Closed
xavArtley opened this issue Nov 2, 2019 · 2 comments · Fixed by #1220
Closed

Should package-lock.json be include? #739

xavArtley opened this issue Nov 2, 2019 · 2 comments · Fixed by #1220
Labels
type: discussion Requiring community discussion type: docs Related to the Panel documentation and examples
Milestone

Comments

@xavArtley
Copy link
Collaborator

Shouldn't we remove package-lock.json from the commited files?
@mattpap

@xavArtley xavArtley added the TRIAGE Default label for untriaged issues label Nov 2, 2019
@xavArtley xavArtley changed the title Should package-lock.json should include? Should package-lock.json be include? Nov 2, 2019
@mattpap
Copy link
Collaborator

mattpap commented Nov 4, 2019

Though it may be tempting due to its usually large size, package-lock.json is a useful tool, which allows to have reproducible environments. Otherwise npm install would result in always installing most recent packages, up to allowed dependency specification. Note however npm install can still change packge-lock.json and upgrade dependencies to some extent. To force npm to only use the lock file, one should use npm ci. This is the command that should be used in CI systems, as it name actually suggests. To fully update dependencies, the approach that works the best for me, is to remove the lock file and run npm install (rm package-lock.json; npm install; git add package-lock.json). I suppose there may be a more idiomatic way that I'm not aware of.

@mattpap mattpap added type: discussion Requiring community discussion and removed TRIAGE Default label for untriaged issues labels Nov 4, 2019
@philippjfr philippjfr added the type: docs Related to the Panel documentation and examples label Nov 6, 2019
@philippjfr
Copy link
Member

We should add some of that to the developer docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: discussion Requiring community discussion type: docs Related to the Panel documentation and examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants