Skip to content

dev: add mise config #6081

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.

Sign up for GitHub

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

Closed
neongreen wants to merge 1 commit into from
Closed

dev: add mise config #6081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ members = ["cli", "lib", "lib/gen-protos", "lib/proc-macros", "lib/testutils"]
[workspace.package]
version = "0.28.2"
license = "Apache-2.0"
rust-version = "1.84" # NOTE: remember to update CI, contributing.md, changelog.md, and install-and-setup.md
rust-version = "1.84" # NOTE: remember to update mise.toml, CI, contributing.md, changelog.md, and install-and-setup.md
Copy link
Copy Markdown
Contributor

@arxanas arxanas Mar 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
rust-version = "1.84" # NOTE: remember to update mise.toml, CI, contributing.md, changelog.md, and install-and-setup.md
rust-version = "1.84" # NOTE: remember to update CI, mise.toml contributing.md, changelog.md, and install-and-setup.md

nit: I feel like "CI" should go first since it's most important, in some sense.

edition = "2021"
readme = "README.md"
homepage = "https://github.com/jj-vcs/jj"
Expand Down
58 changes: 58 additions & 0 deletions mise.toml
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@PhilipMetzger PhilipMetzger Mar 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This currently is missing the documentation update in contributing.md

Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#:schema https://mise.jdx.dev/schema/mise.json

# NOTE: Tool versions repeat throughout this file. Here's why.
# ----------
#
# We could use [vars], but they are not supported in task tools:
# https://github.com/jdx/mise/discussions/4885
#
# We could at least set Rust in [tools], but then it can't be overridden per task.
# (Another bug?)
#
# Finally, adding per-folder [tools] is a bit fragile in general:
# If 'jj' is itself installed via Mise, any 'jj' invocation will want the tools.
# And this can easily fail:
# - "cargo:" tools with unavailable binaries may fail to build on Windows,
# - a binary might not be available for your OS+architecture, etc.

[tools]
# We need cargo-binstall so that Mise would download "cargo:" tools instead of building them.
"cargo-binstall" = "latest"

[tasks."format"]
description = "Format the code"
tools.rust = "nightly"
run = "cargo fmt"

[tasks."lint"]
description = "Lint the code"
tools.rust = "1.86" # newer clippy
run = "cargo clippy --workspace --all-targets --all-features" # TODO: --all-features yay or nay?

[tasks."zizmor"]
Copy link
Copy Markdown
Contributor

@arxanas arxanas Mar 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: zizmor is the specific tool name, while the rest of the task names are pretty abstract. I'd rename this to perhaps check:workflows (as per above), or rename other stuff to e.g. clippy.

description = "Check GitHub workflows with Zizmor"
tools.uv = "0.5.1"
run = "uvx zizmor ."

[tasks."test"]
description = "Run tests"
tools.rust = "1.84"
tools."cargo:cargo-insta" = "1.42.2"
tools."cargo:cargo-nextest" = "0.9.93" # TODO: bump to 0.9.94 to get aarch64 on Win
run = "cargo insta test --workspace --test-runner nextest"

[tasks."update-cli-help"]
description = "Update generated CLI help (cli/tests/cli-reference@.md.snap)"
tools.rust = "1.84"
tools."cargo:cargo-insta" = "1.42.2"
run = "cargo insta test --accept --workspace -- test_generate_md_cli_help"

[tasks."docs:build"]
description = "Build documentation into rendered-docs/ for offline use"
tools.uv = "0.5.1"
run = "uv run mkdocs build -f mkdocs-offline.yml"

[tasks."docs:serve"]
description = "Preview documentation with live reloading"
tools.uv = "0.5.1"
run = "uv run mkdocs serve"
Loading