Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.1.0: ready to replace existing substrate subcommand #6

Merged
merged 44 commits into from
Aug 16, 2023
Merged

Conversation

liamaharon
Copy link
Contributor

@liamaharon liamaharon commented Aug 3, 2023

Standalone try-runtime-cli with feature parity with the existing substrate subcommand.

You can install the cli binary built from this branch to your path to play with by running

$ cargo install --git https://github.com/paritytech/try-runtime-cli --branch liam-v0.1.0
$ try-runtime --help
$ try-runtime on-runtime-upgrade --help
...etc

Once merged, we can deprecate & cease development of the try-runtime subcommand in substrate and polkadot and move development entirely to this repo.

Partial paritytech/substrate#12975

  • Update to work with substrate master
  • Update on_runtime_upgrade, execute_block commands and internal logic to feature parity with substrate
  • Add OffchainWorker command
  • Add FollowChain command
  • Add CreateSnapshot command
  • Migrate tests from Substrate to this repo
  • Update readme.md, make sure docs are tidy and work well
    • Migrate docs
    • Add simple readme
  • Set up reasonable Github Actions CI
    • Rust cargo fmt and clippy
    • Auto deploy docs to Github Pages on merge to main
    • Runs tests I'm experiencing issues running tests in Github Actions. Devops team is probably going to completely re-do the CI/CD here here (seems they're already playing with something), so I'm not going to spend more time trying to fix this.

A note about fast-forward

I have intentionally left fast-forward out of this PR.

It's not documented or really working in substrate currently, the idea of this PR is just to shift all stable features to this repo so we can continue development from here and deprecate try-runtime-cli in substrate.

I plan to work on fast-forward in a seperate PR, and only merge it when it is in a state where it is easy enough to use with any substrate based chain and well documented.

TODO before merge

  • change docs github action to use main branch

cli/main.rs Outdated Show resolved Hide resolved
@liamaharon liamaharon marked this pull request as ready for review August 9, 2023 05:22
@liamaharon liamaharon changed the title v0.1.0 v0.1.0: standalone try-runtime-cli (feature parity with existing substrate subcommand) Aug 9, 2023
@liamaharon liamaharon changed the title v0.1.0: standalone try-runtime-cli (feature parity with existing substrate subcommand) v0.1.0: standalone try-runtime CLI (feature parity with existing substrate subcommand) Aug 9, 2023
@liamaharon liamaharon changed the title v0.1.0: standalone try-runtime CLI (feature parity with existing substrate subcommand) v0.1.0: ready to replace existing substrate subcommand Aug 9, 2023
.github/workflows/rust-checks.yaml Show resolved Hide resolved
.github/workflows/rust-checks.yaml Outdated Show resolved Hide resolved
.github/workflows/rust-docs.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
cli/Cargo.toml Show resolved Hide resolved
cli/Cargo.toml Show resolved Hide resolved
cli/Cargo.toml Show resolved Hide resolved
rust-toolchain.toml Outdated Show resolved Hide resolved
core/Cargo.toml Outdated Show resolved Hide resolved
core/Cargo.toml Show resolved Hide resolved
@pmikolajczyk41
Copy link
Collaborator

I've also one general comment about substrate dependency: I clearly see a reason for depending on the master branch in the Substrate repository, but I also see a big problem for anybody who runs chain that is based on an older Substrate version (essentially any prod chain)

it's out of the scope of this PR, but I would definitely spend some time on discussing how this tool should be versioned; maybe adding tags for polkadot-v0.9.x is enough

@liamaharon
Copy link
Contributor Author

I've also one general comment about substrate dependency: I clearly see a reason for depending on the master branch in the Substrate repository, but I also see a big problem for anybody who runs chain that is based on an older Substrate version (essentially any prod chain)

it's out of the scope of this PR, but I would definitely spend some time on discussing how this tool should be versioned; maybe adding tags for polkadot-v0.9.x is enough

SGTM, let's follow polkadot conventions.

@liamaharon liamaharon merged commit 64a7a17 into main Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants