Command Bot - Help Docs
Based on https://github.com/KILTprotocol/pipeline-scripts/tree/master
rev: 7af8863df939c8fbb5456313ea32697973c9d6ac
Running custom commands, like:localbot command-name -v VAR=value id --argument=1 --argument=2
Or even multiple commands in one comment:localbot clean
localbot command-name --argument=2
localbot command-name --argument=3
To add a new command:
- Go to https://github.com/KILTprotocol/pipeline-scripts
- Add new command and open a PR.
- Read how to test the new command before merging.
- Merge. Then after merging the PR, it will be accessible without branch override.
help
Generates the help page & provides a link.
Example: localbot help
clean
Clears bot comments in the PR.
localbot clean
Works in all repos
Clears all bot comments in the PR, including human comments requesting a command-bot.
Default: falseExample: localbot clean
Patch Companion
Syntax (after command name):
-v PATCH_repo=pull_request_id
Examples:
localbot bench -v PATCH_substrate=11341 polkadot-overhead --network=westend-dev
localbot try-runtime -v PATCH_polkadot=3341 polkadot --network=westend
Test new command.
When you create/modify a command in https://github.com/KILTprotocol/pipeline-scripts/tree/master repo, you can test it before merging to master
Syntax (after command name):
-v PIPELINE_SCRIPTS_REF=your_branch
Examples:
localbot new-command -v PIPELINE_SCRIPTS_REF=mak/new-command new-id --new-arg=value
Override Command's CI Image
You can override command's CI image with any other image, for example when you need to test new version of Rust
Syntax (after command name):
-v CMD_IMAGE=paritytech/ci-unified:bullseye-1.77.0-2024-04-10-v20240408
Examples:
localbot update-ui -v CMD_IMAGE=paritytech/ci-unified:bullseye-1.77.0-2024-04-10-v20240408 --rust_version=1.77.0
Rust Log, etc
You can define custom env variables like for RUST env
Syntax (after command name):
-v RUST_LOG=remote-ext=debug,runtime=trace
Examples:
localbot try-runtime -v RUST_LOG=remote-ext=debug,runtime=trace polkadot --network=westend