Skip to content
This repository was archived by the owner on Aug 1, 2023. It is now read-only.

Commit 119aa62

Browse files
authoredMar 25, 2022
docs: add breaking change interop release process (#395)
1 parent 18649a6 commit 119aa62

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎README.md

+9
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,15 @@ npm publish
105105
npm push origin && npm push origin v[N.N.N]
106106
```
107107

108+
## Interop release process for when breaking changes are introduced
109+
110+
1. Get branches of go-ipfs and js-ipfs working together in interop locally using environment variables to point at the local versions
111+
2. In this repo make a branch containing the interop changes as well as setting the go/js-ipfs commit hashes to be used by CI. Merge to master.
112+
3. Update go-ipfs and js-ipfs branches to use interop/master instead of whatever is released
113+
4. Release go and js-ipfs (not necessarily together) and after each is released (or RC'd) bump interop to use the release instead of the commit hash
114+
5. Release interop
115+
6. Bump go and js-ipfs to use released interop instead of master
116+
108117
## Contribute
109118

110119
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/ipfs-interop/issues)!

0 commit comments

Comments
 (0)
This repository has been archived.