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

chore(package): bump versions and ignore package-lock.json #261

Merged
merged 3 commits into from
Jul 8, 2017

Conversation

lidel
Copy link
Member

@lidel lidel commented Jul 1, 2017

According to npm help package-lock.json:

package-lock.json is automatically generated for any operations where npm modifies either the node_modules tree, or package.json. It describes the exact tree that was generated, such that subsequent installs are able to generate identical trees, regardless of intermediate dependency updates.

This file is intended to be committed into source repositories, and serves various purposes:

  • Describe a single representation of a dependency tree such that teammates, deployments, and continuous integration are guaranteed to install exactly the same dependencies.

  • Provide a facility for users to "time-travel" to previous states of node_modules without having to commit the directory itself.

  • To facilitate greater visibility of tree changes through readable source control diffs.

  • And optimize the installation process by allowing npm to skip repeated metadata resolutions for previously-installed packages.

My understanding is that including it in repository should finally give us deterministic builds, but please someone review this before we merge it.

PS. I know that package-lock.json may produce errors if node_modules was already present until fix for npm/npm#16839 is released, so if you experience any issues remove node_modules before running npm install for this branch.

@lidel lidel added kind/maintenance Work required to avoid breaking changes or harm to project's status quo topic/security Work related to security labels Jul 1, 2017
@lidel lidel requested a review from daviddias July 1, 2017 20:31
@daviddias
Copy link
Member

I've experienced many errors with the new npm5 which made me revert the usage of it on js-ipfs and js-ipfs-api. I do hope to use it in the future and feel free to use it for this repo, just bare in mind that there will be issues of missing npm installs and lack of proper updates until all npm5 issues are fixed. These issues will be certainly frustrating for other contributors that have less introspection of what is going on.

@lidel lidel changed the title chore(package): bump versions and add package-lock.json chore(package): bump versions and ignore package-lock.json Jul 8, 2017
@lidel lidel merged commit 71ede4a into master Jul 8, 2017
@lidel lidel deleted the package-lock branch July 8, 2017 15:59
@lidel
Copy link
Member Author

lidel commented Jul 8, 2017

I played with it a bit, and indeed, currently it is very buggy.
I merged version bumps, but I've added package-lock.json to .gitignore so that it is not committed by mistake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/maintenance Work required to avoid breaking changes or harm to project's status quo topic/security Work related to security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants