This project is NOT the srtool docker image that is actually used to build Substrate Wasm Runtime. This utility requires docker to be installed and running and will invoke the srtool image to help you build a Substrate runtime.
This project is a cli interface to docker to simplify using the srtool docker image. With this executable, you no longer need
to set and maintain a long and complex alias, as currently described in the srtool documentation.
If you previously defined srtool as an alias, you will first need to remove it first.
If you used srtool in the past, you previously used an srtool alias. You can check with:
type srtool
If you see some output mentioning "srtool is an alias for docker run…", you have an alias set and we need to remove it:
unalias srtool
This alias is likely set in your .bash_profile or .zshrc, make sure to remove this alias there as well.
cargo install --git https://github.com/chevdor/srtool-cli
help
srtool-cli 0.6.0
chevdor <chevdor@gmail.com>
This utility helps starting a container from the srtool Docker image. It passes the right parameters
and environment variables to the container. Learn more about the srtool image here:
https://github.com/paritytech/srtool
USAGE:
srtool [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-j, --json This option is DEPRECATED and has no effect
-n, --no-cache Do not use the local cached tag value
-V, --version Prints version information
OPTIONS:
-i, --image <image> Chose an alternative image. Beware to chose an image that is compatible
with the original srtool image. Using a random image, you take the risk
to NOT produce exactly the same deterministic result than srtool
[default: paritytech/srtool]
SUBCOMMANDS:
build Start a new srtool container to build your runtime
help Prints this message or the help of the given subcommand(s)
info Provide information about the srtool container and your repo
pull Simply pull the srtool image and do not run anything else
version Show the versions of the srtool container. Use --version if you want the version
of this executable
version
srtool-version 0.6.0
chevdor <chevdor@gmail.com>
Show the versions of the srtool container. Use --version if you want the version of this executable
USAGE:
srtool version
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
info
srtool-info 0.6.0
chevdor <chevdor@gmail.com>
Provide information about the srtool container and your repo
USAGE:
srtool info [OPTIONS] --package <package> [path]
ARGS:
<path> By default, srtool will work in the current folder. If your project is located in
another location, you can pass it here [default: .]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-p, --package <package> Provide the runtime such as kusama-runtime, polkadot-runtime,
etc... [env: PACKAGE=]
-r, --runtime-dir <runtime-dir> If your runtime is not in the standard location
runtime/<chain_name> you can pass this args to help srtool
find it [env: RUNTIME_DIR=]
pull
srtool-pull 0.6.0
chevdor <chevdor@gmail.com>
Simply pull the srtool image and do not run anything else
USAGE:
srtool pull
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
build
srtool-build 0.6.0
chevdor <chevdor@gmail.com>
Start a new srtool container to build your runtime
USAGE:
srtool build [FLAGS] [OPTIONS] --package <package> [path]
ARGS:
<path> By default, srtool will work in the current folder. If your project is located in
another location, you can pass it here [default: .]
FLAGS:
-a, --app Enable the "app" mode which is a mix of json output and outputing progress
during the build. This flag is recommended for CI. the json output will be
provided as a single line at the end in compact mode
-h, --help Prints help information
-j, --json Enable json output, same than the global --json option
--no-cache Passsing this flag allows completely disabling caching. As a result, no cargo-
home will be mounted to the srtool image. There is no known issue with having
the cache ON, this is why it is the default
-V, --version Prints version information
OPTIONS:
--build-opts <build-opts>
You may pass options to cargo directly here. WARNING, if you pass this value, the
automatic build options for Kusama and Polkadot will not be passed and you need to take
care of them manually. In general, you should never use this option unless you HAVE to
[env: BUILD_OPTS=]
--default-features <default-features>
Passing this is less involved than passing BUILD_OPTS. It allows changing the list of
default features while keeping the automatic features detection. This value is useless
if BUILD_OPTS is set [env: DEFAULT_FEATURES=]
-p, --package <package>
Provide the runtime such as kusama-runtime, polkadot-runtime, etc... [env: PACKAGE=]
--profile <profile>
The default profile to build runtimes is always `release`. You may override the default
with this flag [env: PROFILE=] [default: release]
-r, --runtime-dir <runtime-dir>
If your runtime is not in the standard location runtime/<chain_name> you can pass this
args to help srtool find it [env: RUNTIME_DIR=]
If you landed here, you likely want to contribute the project. Let me thank you already. There are several ways you can help. Please start with the few notes below.
Whether you are reporting an issue you ran into or requesting a new feature, please open an issue here.
You know the drill: please try to provide some context information, the version you used, your OS, how to reproduce. That will greatly help solving your issue quicker.
The documentation of this project is mainly done using AsciiDoc. Unfortunately, it takes litterally ages for Github to support THE feature that makes AsciiDoc shine.
As a result, for now, this project is generating the markdwown from AsciiDoc. In short that means that you should NOT modify any .md file but change the .adoc ones and run just md to generate all the markdown.
This project is mainly using Rust so you will need to install the Rust compiler. Make sure everything works with the latest stable version of Rust.
You will find a justfile in the root of the repo. This is to be used with just so you may want to install that as well. Just type just 😁 to discover how it can help you.
Before submitting your code, do a cargo clippy stop to make sure everything works fine. Don’t forget to cargo fmt --all as well if you want to be friend with the CI. No surprise, the test can be ran using cargo test.
You may activate the logs for the project using RUST_LOG=debug for instance.
PRs are welcome. Feel free to open them early before putting too much effort (you may start with a draft). This way you can ping me (@chevdor) if you want my opinion on what and how you are putting your change together.