chore: begin replacement of Make and `./scripts/gear.sh` with Just by liferooter · Pull Request #4862 · gear-tech/gear

liferooter · 2025-09-23T09:52:51Z

Introduces justfile as an alternative to existing Makefile and ./scripts/gear.sh.
Implements some commonly used Make targets as Just recipes.
Replaces usage of ./scripts/gear.sh with usage of Just in some parts of CI.
Inline some usages of ./scrpts/gear.sh in CI where there's no need for abstraction into a script.

semanticdiff-com · 2025-09-23T09:52:54Z

Review changes with

Changed Files

File	Status
.github/workflows/comparison-table.yml	36% smaller
.github/workflows/time-consuming-tests.yml	29% smaller
.github/workflows/check.yml	14% smaller
.github/actions/install-cargo-extensions/action.yml	0% smaller
.github/workflows/build-linux.yml	0% smaller
.github/workflows/build.yml	0% smaller
.github/workflows/test-measurements.yaml	0% smaller
just/clippy.just	Unsupported file format
just/ethexe.just	Unsupported file format
just/lib.just	Unsupported file format
justfile	Unsupported file format
shell.nix	Unsupported file format

breathx · 2025-09-23T10:52:01Z


      - name: "Check clippy"
-        run: ./scripts/gear.sh clippy gear --all-targets --all-features --locked
+        run: just clippy native


its more likely
just clippy :: { workspace ; examples } -> not the point that its wasms
but moreover these steps could be merged into one

breathx · 2025-09-23T10:52:36Z

+      - name: "Install: Cargo extensions"
+        uses: ./.github/actions/install-cargo-extensions
+
      - name: "Show: Versioning"


such simple commands could be nameless in CI

Other such commands, like "Install: Rust toolchain" or "Install: Foundry" are not nameless.

ark0f · 2025-09-27T12:22:26Z

require() may simplify script

https://just.systems/man/en/functions.html#executables

My custom ensure-* repices are more powerful than Just's require function.

It shows hint that describes how to install the program.

It is recipe-specific, not global.

It is custom enough to be able to check Cargo extensions.

ark0f · 2025-09-27T12:30:27Z

+# Format code via `rustfmt`
+[group('actions')]
+fmt:
+    cargo fmt --all
+
+# Check formatting with `rustfmt`
+[group('checks')]
+fmt-check:
+    cargo fmt --all --check


Suggested change

# Format code via `rustfmt`

[group('actions')]

fmt:

cargo fmt --all

# Check formatting with `rustfmt`

[group('checks')]

fmt-check:

cargo fmt --all --check

# Format code via `rustfmt`

[group('actions')]

fmt *ARGS:

cargo fmt --all {{ARGS}}

I think having a separate fmt-check recipe is better for some reasons:

Accepting arguments by fmt recipe is not very useful because the only useful argument that can be passed to it is --check.

Recipes with arguments cannot be chained (e.g. we can't run just fmt typos test-doc), so it makes sense to refrain from using recipes with arguments as much as possible.

Having a separate fmt-check recipe improves autocompletion for this recipe.

Having a separate fmt-check recipe allows to used it as a dependency (like for pre-commit) without causing an argument passing hell like what we have in Makefile and gear.sh now.

ark0f · 2025-09-27T12:56:09Z

+[group('checks')]
+test-doc:
+    # Running documentation tests
+    __GEAR_WASM_BUILDER_NO_BUILD=1 \
+    SKIP_WASM_BUILD=1 \
+        cargo test --doc --workspace --no-fail-fast


Suggested change

[group('checks')]

test-doc:

# Running documentation tests

__GEAR_WASM_BUILDER_NO_BUILD=1 \

SKIP_WASM_BUILD=1 \

cargo test --doc --workspace --no-fail-fast

[group('checks')]

test-doc $__GEAR_WASM_BUILDER_NO_BUILD="1" $SKIP_WASM_BUILD="1":

cargo test --doc --workspace --no-fail-fast

It was done on purpose. Using long recipe-specific environment variables makes help messages very ugly and also confuses by being the only thing about running commands that is not printed during recipe execution.

ark0f · 2025-09-27T12:58:09Z

+test: (ensure-cargo "hack") (ensure-cargo "nextest")
+    # Running workspace tests
+    cargo nextest run \
+        --workspace \
+        --no-fail-fast \
+        --exclude gclient \
+        --exclude gcli \
+        --exclude gsdk \
+        --exclude gear-authorship \
+        --exclude pallet-gear-staking-rewards \
+        --exclude gear-wasm-gen \
+        --exclude demo-stack-allocations \
+        --exclude gring \
+        --exclude runtime-fuzzer \
+        --exclude runtime-fuzzer-fuzz


Suggested change

test: (ensure-cargo "hack") (ensure-cargo "nextest")

# Running workspace tests

cargo nextest run \

--workspace \

--no-fail-fast \

--exclude gclient \

--exclude gcli \

--exclude gsdk \

--exclude gear-authorship \

--exclude pallet-gear-staking-rewards \

--exclude gear-wasm-gen \

--exclude demo-stack-allocations \

--exclude gring \

--exclude runtime-fuzzer \

--exclude runtime-fuzzer-fuzz

test *ARGS: (ensure-cargo "hack") (ensure-cargo "nextest")

# Running workspace tests

cargo nextest run --workspace --all-targets --all-features -E 'not package(/fuzz/)' {{ARGS}}

Simplification is done.

Argument passing is a bad idea I think.

It is not very useful, because for running tests for specific crates or with specific options it's better to use cargo nextest directly for better control and more explicitness. The point of the recipe is to give us a short command for a common non-trivial testing task, not to give us an universal script runner, for which always having all these options by default is not a good idea.

The same reasons as with fmt-check. Recipes without arguments can be chained, generally cleaner and will never cause argument passing hell.

ark0f · 2025-09-27T13:03:08Z

+# Check all WASM code
+wasm:
+    # Checking all WASM code with Clippy
+    cargo metadata --no-deps --format-version=1 \


Consider to use shebang scripts and paste lines directly from ./scripts/src/clippy.sh

This makes `pre-commit` recipe a check-only recipe, making it more consistent and also allowing it to be used after adding changes to Git index without need to manually recheck worktree for changes done by `cargo fmt`.

grishasobol · 2026-04-06T14:57:03Z

Consult with @breathx and decided to be closed

liferooter added 7 commits September 17, 2025 12:51

Add just and just-lsp to Nix devenv

d855e70

Implement some basic tasks in justfile

e5c00da

Add test recipe to justfile

dec2dd9

Add task for checking runtime imports into justfile

f8f5129

Split clippy into clippy-examples and clippy-gear

014b67d

Implement more Just recipes and reorganize justfiles

b1a45ac

Reduce usage of ./scripts/gear.sh in CI

259e434

liferooter requested a review from ark0f September 23, 2025 09:52

liferooter added the D5-tooling Helper tools and utilities label Sep 23, 2025

liferooter added the A0-pleasereview PR is ready to be reviewed by the team label Sep 23, 2025

Fix install-cargo-extensions action

706031d

breathx approved these changes Sep 23, 2025

View reviewed changes

Fix Nextest installation in CI

9693e48

ark0f requested changes Sep 27, 2025

View reviewed changes

liferooter added 8 commits September 29, 2025 19:32

Remove check recipe

fc7cb0f

Remove unneeded parentheses

58e1f74

Use fmt-check instead of fmt in pre-commit recipe

dd65b9a

This makes `pre-commit` recipe a check-only recipe, making it more consistent and also allowing it to be used after adding changes to Git index without need to manually recheck worktree for changes done by `cargo fmt`.

Simplify test recipe

ca77520

Simplify check-runtime-imports recipe

cf0e8a5

Use cargo binstall to install cargo-{nextest,hack} in CI

d2b1bb9

Merge branch 'master' into gs-rework-scripts

a31589b

Fix installation of Cargo extensions in CI

a31cb84

grishasobol closed this Apr 6, 2026

Conversation

liferooter commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

semanticdiff-com Bot commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

grishasobol commented Apr 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

liferooter commented Sep 23, 2025 •

edited

Loading

semanticdiff-com Bot commented Sep 23, 2025 •

edited

Loading