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

Commit

Permalink
revert: docs: add migration note about upgrading from < 0.30.0 (#1450)
Browse files Browse the repository at this point in the history
This reverts commit 48aceb1.

This issue was fixed upstream. As we use version ranges for dependencies,
it is automatically fixed now. Hence reverting the original commit.
  • Loading branch information
vmx committed Jul 20, 2018
1 parent 48aceb1 commit 9b81f89
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 20 deletions.
13 changes: 0 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,6 @@ Signed-off-by: David Dias <mail@daviddias.me>
License: MIT
Signed-off-by: Alan Shaw <alan@tableflip.io>

* Git pre-push hook has been removed

**This only applies to developers that build IPFS from source, not for consumers**

This can cause problems during installation of npm dependencies, in case the repository
is not freshly cloned. Prior to 0.30.0 a pre-push hook has been set up to verify
changes before sending them to a remote repository. Due to the removal, existing
installations will have dead symlinks that cause `npm install` to fail.

The migration path is to remove the `pre-hook` file/symlink inside `.git/hooks` of
your clone.

[Read this issue](https://github.com/ipfs/js-ipfs/issues/1444) for more information.


<a name="0.29.3"></a>
Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,6 @@ You can check the development status at the [Waffle Board](https://waffle.io/ipf

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


### Upgrading from < 0.30.0

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).

## Tech Lead

[David Dias](https://github.com/diasdavid)
Expand Down Expand Up @@ -365,10 +360,10 @@ The core API is grouped into several areas:
- [`ipfs.files.addPullStream([options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesaddpullstream)
- [`ipfs.files.addReadableStream([options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesaddreadablestream)
- [`ipfs.files.cat(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescat). Alias to `ipfs.cat`.
- [`ipfs.files.catPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatpullstream)
- [`ipfs.files.catPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatpullstream)
- [`ipfs.files.catReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescatreadablestream)
- [`ipfs.files.get(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesget). Alias to `ipfs.get`.
- [`ipfs.files.getPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetpullstream)
- [`ipfs.files.getPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetpullstream)
- [`ipfs.files.getReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesgetreadablestream)
- [`ipfs.ls(ipfsPath, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#ls)
- [`ipfs.lsPullStream(ipfsPath)`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#lspullstream)
Expand Down

0 comments on commit 9b81f89

Please sign in to comment.