diff --git a/.github/mergify.yml b/.github/mergify.yml index bb04d143e..639b42d2f 100644 --- a/.github/mergify.yml +++ b/.github/mergify.yml @@ -1,7 +1,7 @@ pull_request_rules: - name: backport to maintained branches conditions: - - base~=^(main|v6)$ + - base~=^(main|v7)$ - label=BACKPORT actions: backport: @@ -18,7 +18,7 @@ pull_request_rules: - name: automerge backported PR's for maintained branches conditions: - label=automerge - - base=v6 + - base=v7 actions: merge: method: squash \ No newline at end of file diff --git a/README.md b/README.md index cd588df65..83eb14e09 100644 --- a/README.md +++ b/README.md @@ -15,61 +15,48 @@ Formerly known as `ibctest`. It allows users to quickly spin up custom testnets and dev environments to test IBC, chain infrastructures, smart contracts, etc. -### -- Features -- - -- Built-in suite of conformance tests to test high-level IBC compatibility between chain sets -- Easily construct customized tests in highly configurable environments -- Deployable as CI tests in production workflows +## Table Of Contents +- [Branch Versioning](#maintained-branches) +- **Use Cases:** + - **Importing as a Module** + - [Chain Integration and GitHub CI](./docs/ciTests.md) + - **Running as a Binary** + - [Building Binary](./docs/buildBinary.md) + - [Running Conformance Tests](./docs/conformanceTests.md) - Suite of built-in tests that test high-level IBC compatibility +- [Write Custom Tests](./docs/writeCustomTests.md) +- [Retaining Data on Failed Tests](./docs/retainingDataOnFailedTests.md) -
### Maintained Branches -#### Backport Policy: -Strangelove maintains `n` and `n - 1` branches of interchaintest, `n` being current `main`. +| **Branch Name** | **IBC-Go** | **Cosmos-sdk** | +|:----------------------------------------------------------------------------:|:----------:|:--------------:| +| [main](https://github.com/strangelove-ventures/interchaintest) | v8 | v0.50 | +| [v7](https://github.com/strangelove-ventures/interchaintest/tree/v7) | v7 | v0.47 | -We strive to keep interchaintest inline with the latest from the ibc-go and cosmos sdk teams. Once an alpha versions of the next major ibc-go version is released, we will discontinue `n - 1` and branch off a new `n`. +### Depreciated Branches -**Recommendation:** Even if your chain uses an older version of ibc-go, try importing from `main`. This should work unless you are decoding transactions that require a specific ibc-go version. +These are branches that we no longer actively update or maintain but may be of use if a chain is running older versions of the `Cosmos SDK ` or `IBC Go`. Please see the [Backport Policy](#backport-policy) below. -If there is a feature you would like backported to an older branch, make an issue! We are happy to work with you. -| **Branch Name** | **IBC-Go** | **Cosmos-sdk** | **Maintained** | -|:----------------------------------------------------------------------------:|:----------:|:--------------:|:-------------------:| -| [main](https://github.com/strangelove-ventures/interchaintest) | v7 | v0.47 | ✅ | -| [v6](https://github.com/strangelove-ventures/interchaintest/tree/v6) | v6 | v0.46 | ✅ | -| [v5](https://github.com/strangelove-ventures/interchaintest/tree/v5) | v5 | v0.46 |❌
(Aug 11 2023) | -| [v4](https://github.com/strangelove-ventures/interchaintest/tree/v4) | v4 | v0.45 |❌
(Aug 11 2023) | -| [v4-ics](https://github.com/strangelove-ventures/interchaintest/tree/v4-ics) | v4 | v0.45.x-ics |❌
(Aug 11 2023) | -| [v3](https://github.com/strangelove-ventures/interchaintest/tree/v3) | v3 | v0.45 |❌
(June 25 2023) | -| [v3-ics](https://github.com/strangelove-ventures/interchaintest/tree/v3-ics) | v3 | v0.45.11-ics |❌
(April 24 2023)| +| **Branch Name** | **IBC-Go** | **Cosmos-sdk** | **Depreciated Date** | +|:----------------------------------------------------------------------------:|:----------:|:--------------:|:--------------------:| +| [v6](https://github.com/strangelove-ventures/interchaintest/tree/v6) | v6 | v0.46 | Sept 5 2023 | +| [v5](https://github.com/strangelove-ventures/interchaintest/tree/v5) | v5 | v0.46 | Aug 11 2023 | +| [v4](https://github.com/strangelove-ventures/interchaintest/tree/v4) | v4 | v0.45 | Aug 11 2023 | +| [v4-ics](https://github.com/strangelove-ventures/interchaintest/tree/v4-ics) | v4 | v0.45.x-ics | Aug 11 2023 | +| [v3](https://github.com/strangelove-ventures/interchaintest/tree/v3) | v3 | v0.45 | June 25 2023 | +| [v3-ics](https://github.com/strangelove-ventures/interchaintest/tree/v3-ics) | v3 | v0.45.11-ics | April 24 2023 | -## Table Of Contents -- [Building Binary](#building-binary) -- **Usage:** - - [Running Conformance Tests](./docs/conformanceTests.md) - Suite of built-in tests that test high-level IBC compatibility - - [Write Custom Tests](./docs/writeCustomTests.md) -- [Retaining Data on Failed Tests](./docs/retainingDataOnFailedTests.md) -- [Deploy as GitHub CI Tests](./docs/ciTests.md) +#### Backport Policy: +Strangelove maintains `n` and `n - 1` branches of interchaintest, `n` being current `main`. -
- - -## Building Binary - -While it is not necessary to build the binary, sometimes it can be more convenient, *specifically* when running conformance test with custom chain sets. - -Building binary: -```shell -git clone https://github.com/strangelove-ventures/interchaintest.git -cd interchaintest -make interchaintest -``` +We strive to keep interchaintest inline with the latest from the ibc-go and cosmos sdk teams. Once an alpha versions of the next major ibc-go version is released, we will discontinue `n - 1` and branch off a new `n`. -This places the binary in `interchaintest/bin/interchaintest` +**Recommendation:** Even if your chain uses an older version of ibc-go, try importing from `main`. This should work unless you are decoding transactions that require a specific ibc-go version. -Note that this is not in your Go path. +If there is a feature you would like backported to an older branch, make an issue! We are happy to work with you. ## Contributing diff --git a/docs/buildBinary.md b/docs/buildBinary.md new file mode 100644 index 000000000..1aeb9868d --- /dev/null +++ b/docs/buildBinary.md @@ -0,0 +1,14 @@ +## Building Binary + +While it is not necessary to build the binary, sometimes it can be more convenient, *specifically* when running conformance test with custom chain sets. + +Building binary: +```shell +git clone https://github.com/strangelove-ventures/interchaintest.git +cd interchaintest +make interchaintest +``` + +This places the binary in `interchaintest/bin/interchaintest` + +Note that this is not in your Go path. \ No newline at end of file