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

Commit d935216

Browse files
committed
chore(readme): add migration note about upgrading from < 0.30.0
Closes #1444 License: MIT Signed-off-by: Pascal Precht <pascal.precht@gmail.com>
1 parent d28d13d commit d935216

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,19 @@ Signed-off-by: David Dias <mail@daviddias.me>
5353
License: MIT
5454
Signed-off-by: Alan Shaw <alan@tableflip.io>
5555

56+
* Git pre-push hook has been removed
57+
58+
**This only applies to developers that build IPFS from source, not for consumers**
59+
60+
This can cause problems during installation of npm dependencies, in case the repository
61+
is not freshly cloned. Prior to 0.30.0 a pre-push hook has been set up to verify
62+
changes before sending them to a remote repository. Due to the removal, existing
63+
installations will have dead symlinks that cause `npm install` to fail.
64+
65+
The migration path is to remove the `pre-hook` file/symlink inside `.git/hooks` of
66+
your clone.
67+
68+
[Read this issue](https://github.com/ipfs/js-ipfs/issues/1444) for more information.
5669

5770

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

README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ 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+
### Upgrading from < 0.30.0
47+
48+
If you're upgrading from < 0.30.0 you might run into errors when installing dependencies due to non-existing git hooks. For fixes, please refer to the [changelog](https://github.com/ipfs/js-ipfs/blob/master/CHANGELOG.md#breaking-changes).
49+
4550
## Tech Lead
4651

4752
[David Dias](https://github.com/diasdavid)
@@ -360,10 +365,10 @@ The core API is grouped into several areas:
360365
- [`ipfs.files.addPullStream([options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesaddpullstream)
361366
- [`ipfs.files.addReadableStream([options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesaddreadablestream)
362367
- [`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)
368+
- [`ipfs.files.catPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatpullstream)
364369
- [`ipfs.files.catReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatreadablestream)
365370
- [`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)
371+
- [`ipfs.files.getPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetpullstream)
367372
- [`ipfs.files.getReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetreadablestream)
368373
- [`ipfs.ls(ipfsPath, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#ls)
369374
- [`ipfs.lsPullStream(ipfsPath)`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#lspullstream)

0 commit comments

Comments
 (0)