Skip to content

Commit

Permalink
updated README.md with releases (rollkit#1190)
Browse files Browse the repository at this point in the history
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

---------

Co-authored-by: Ganesha Upadhyaya <gupadhyaya@Ganeshas-MacBook-Pro-2.local>
Co-authored-by: nashqueue <99758629+nashqueue@users.noreply.github.com>
  • Loading branch information
3 people authored and chandiniv1 committed Oct 19, 2023
1 parent affed7b commit efe4240
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,31 @@ There are currently 2 ways to build on Celestia:

| network | rollkit | celestia-node | celestia-app |
|-----------------------|------------|---------------|--------------|
| local-celestia-devnet | v0.9.0 | v0.11.0-rc6 | v1.0.0-rc7 |
| arabica | v0.9.0 | v0.11.0-rc6 | v1.0.0-rc7 |
| local-celestia-devnet | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |
| arabica-10 | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |
| mocha-4 | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |

| rollkit/cosmos-sdk | rollkit/cometbft | rollkit |
|---------------------------------------------|------------------------------------|------------|
| v0.46.13-rollkit-v0.9.0-no-fraud-proofs | v0.0.0-20230524013049-75272ebaee38 | v0.9.0 |
| v0.45.16-rollkit-v0.9.0-no-fraud-proofs | v0.0.0-20230524013001-2968c8b8b121 | v0.9.0 |
| rollkit/cosmos-sdk | cometbft | rollkit |
|-----------------------------------------------------------|------------------------------------|------------|
| [v0.47.3-rollkit-v0.10.4-no-fraud-proofs](https://github.com/rollkit/cosmos-sdk/releases/tag/v0.47.3-rollkit-v0.10.4-no-fraud-proofs) | v0.37.2 | [v0.10.4](https://github.com/rollkit/rollkit/releases/tag/v0.10.4) |
| [v0.50.0-rc.0-rollkit-v0.11.0-rc1-no-fraud-proofs](https://github.com/rollkit/cosmos-sdk/releases/tag/v0.50.0-rc.0-rollkit-v0.11.0-rc1-no-fraud-proofs) | v0.38.0-rc3 | [v0.11.0-rc1](https://github.com/rollkit/rollkit/releases/tag/v0.11.0-rc1)|

#### Local Development Environment

The Rollkit v0.9.0 release is compatible with the
The Rollkit v0.10.4 release is compatible with the
[local-celestia-devnet](https://github.com/rollkit/local-celestia-devnet)
[oolong](https://github.com/rollkit/local-celestia-devnet/releases) release. This version combination is compatible with
[celestia-app](https://github.com/celestiaorg/celestia-app) v1.0.0-rc7 and
[celestia-node](https://github.com/celestiaorg/celestia-node) v0.11.0-rc6.
[v0.11.0-rc12](https://github.com/rollkit/local-celestia-devnet/releases/tag/v0.11.0-rc12) release. This version combination is compatible with
[celestia-app](https://github.com/celestiaorg/celestia-app) v1.0.0-rc14 and
[celestia-node](https://github.com/celestiaorg/celestia-node) v0.11.0-rc12.

#### Arabica and Mocha Testnets

The Rollkit v0.9.0 release is compatible with [Arabica](https://docs.celestia.org/nodes/arabica-devnet/) devnet which is running [celestia-app](https://github.com/celestiaorg/celestia-app) v1.0.0-rc7 and
[celestia-node](https://github.com/celestiaorg/celestia-node) v0.11.0-rc6.
The Rollkit v0.10.4 release is compatible with [arabica-10](https://docs.celestia.org/nodes/arabica-devnet/) devnet [mocha-4](https://docs.celestia.org/nodes/mocha-testnet/) testnet which are running [celestia-app](https://github.com/celestiaorg/celestia-app) v1.0.0-rc14 and
[celestia-node](https://github.com/celestiaorg/celestia-node) v0.11.0-rc12.

> :warning: **Rollkit v0.9.0 is not tested for compatibility with latest releases of Mocha.** :warning:
#### Cometbft v0.38.x and Cosmos-SDK v0.50.x

The Rollkit v0.11.0-rc1 release is compatible with Cometbft v0.38.0-rc3 and Cosmos-SDK v0.50.0-rc.0. However, there is no support by ignite for launching a compatible app (e.g. gm app) and Rollkit is working on building a gm app for testing this release (WIP).

### Tools

Expand Down
39 changes: 39 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Release

## Steps

* Release new Rollkit version
* Update [Rollkit/Cosmos-SDK](https://github.com/rollkit/cosmos-sdk) with the newly released Rollkit version
* Release new Rollkit/Cosmos-SDK version

## Releasing a new Rollkit version

### Two ways

* [CI and Release Github Actions Workflows](https://github.com/rollkit/rollkit/actions/workflows/ci_release.yml)
* [Manual](https://github.com/rollkit/rollkit/releases)

#### CI and Release Actions Workflows

![CI and Release](./assets/ci-release.png)

#### Manual

![Manual](./assets/manual.png)

![Manual](./assets/manual-2.png)

## Update Rollkit/Cosmos-SDK

### Steps

* Navigate to the branch that you want to update. e.g., [release/v0.47.x](https://github.com/rollkit/cosmos-sdk/tree/release/v0.47.x) or [release/v0.47.x](https://github.com/rollkit/cosmos-sdk/tree/release/v0.50.x)
* Modify go.mod with the newly released rollkit version. e.g., `github.com/rollkit/rollkit v0.10.4`
* Run `go mod tidy` for updating the dependencies for the newly added rollkit version
* Make a pull request/commit the changes

## Release new Rollkit/Cosmos-SDK version

### Steps

* Make a new release of the Rollkit/Cosmos-SDK by [drafting new release](https://github.com/rollkit/cosmos-sdk/releases)
Binary file added assets/ci-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/manual-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/manual.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit efe4240

Please sign in to comment.