Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 336beb7

Browse files
committed
chore(README): Add migration note about upgrading from < 0.30.0
Closes #1444 License: MIT Signed-off-by: Pascal Precht <[email protected]>
1 parent d28d13d commit 336beb7

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,17 @@ Signed-off-by: David Dias <[email protected]>
5353
License: MIT
5454
Signed-off-by: Alan Shaw <[email protected]>
5555

56+
* Git pre-push hook has been removed
57+
58+
This can cause problems during installation of npm dependencies, in case the repository
59+
is not freshly cloned. Prior to 0.30.0 a pre-push hook has been set up to verify
60+
changes before sending them to a remote repository. Due to the removal, existing
61+
installations will have dead symlinks that cause `npm install` to fail.
62+
63+
The migration path is to remove the `pre-hook` file/symlink inside `.git/hooks` of
64+
your clone.
65+
66+
[Read here](https://github.com/ipfs/js-ipfs/blob/master/README.md#important-note) for more information.
5667

5768

5869
<a name="0.29.3"></a>

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ You can check the development status at the [Waffle Board](https://waffle.io/ipf
4242

4343
[**`Weekly Core Dev Calls`**](https://github.com/ipfs/pm/issues/650)
4444

45+
46+
### Important note
47+
48+
If you're upgrading from < 0.30.0 to >= 0.30.0 you might run into errors when installing dependencies due to non-existing git hooks [as discussed here](https://github.com/ipfs/js-ipfs/issues/1444).
49+
50+
Please remove `.git/hooks/pre-push` first and run `npm install` again to fix this issue as mentioned in the linked discussed above.
51+
4552
## Tech Lead
4653

4754
[David Dias](https://github.com/diasdavid)
@@ -360,10 +367,10 @@ The core API is grouped into several areas:
360367
- [`ipfs.files.addPullStream([options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesaddpullstream)
361368
- [`ipfs.files.addReadableStream([options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesaddreadablestream)
362369
- [`ipfs.files.cat(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescat). Alias to `ipfs.cat`.
363-
- [`ipfs.files.catPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatpullstream)
370+
- [`ipfs.files.catPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatpullstream)
364371
- [`ipfs.files.catReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatreadablestream)
365372
- [`ipfs.files.get(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesget). Alias to `ipfs.get`.
366-
- [`ipfs.files.getPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetpullstream)
373+
- [`ipfs.files.getPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetpullstream)
367374
- [`ipfs.files.getReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetreadablestream)
368375
- [`ipfs.ls(ipfsPath, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#ls)
369376
- [`ipfs.lsPullStream(ipfsPath)`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#lspullstream)

0 commit comments

Comments
 (0)