docs(lockfile): update documentation for recent lockfile changes #7107
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the lockfile documentation to reflect recent changes introduced in mise v2025.11.10, including cross-platform lockfile generation, TOML array format for tools, backend-specific options, strict lockfile mode, and environment-specific versions.
Key changes:
- Updated file format examples to use array syntax
[[tools.name]]instead of table syntax[tools.name] - Added documentation for new fields (
options,env) and features (strict lockfile mode, local lockfiles, environment-specific versions) - Removed outdated legacy format migration and benefits sections
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| tiny = "2" | ||
| ``` | ||
|
|
||
| When you run `MISE_ENV=test mise use tiny@2`, the lockfile will include: |
There was a problem hiding this comment.
The command example mise use tiny@2 doesn't match the context. Based on the example at line 105 showing tiny = "2" in mise.test.toml, the command should be mise use tiny@2 --env test or the description should clarify that the tool is being added to the test environment config file.
Suggested change
| When you run `MISE_ENV=test mise use tiny@2`, the lockfile will include: | |
| When you run `mise use tiny@2 --env test`, the lockfile will include: |
- Update file format examples to use array syntax [[tools.name]] - Add documentation for new fields: options, env - Add Environment-Specific Versions section - Add Local Lockfiles section (mise.local.lock) - Add Strict Lockfile Mode section (locked setting) - Remove outdated Legacy Format Migration and Benefits sections 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
jdx
force-pushed
the
docs/lockfile-updates
branch
from
9289ffe to
e6fe67f
Compare
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.11.10 x -- echo |
19.7 ± 0.6 | 19.0 | 24.7 | 1.03 ± 0.03 |
mise x -- echo |
19.2 ± 0.3 | 18.5 | 21.3 | 1.00 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.11.10 env |
19.0 ± 0.3 | 18.3 | 20.2 | 1.00 ± 0.04 |
mise env |
19.0 ± 0.6 | 18.0 | 24.1 | 1.00 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.11.10 hook-env |
19.7 ± 0.8 | 18.5 | 22.2 | 1.04 ± 0.05 |
mise hook-env |
19.0 ± 0.6 | 18.0 | 25.4 | 1.00 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.11.10 ls |
16.6 ± 0.4 | 15.9 | 18.7 | 1.02 ± 0.04 |
mise ls |
16.3 ± 0.5 | 15.5 | 18.5 | 1.00 |
xtasks/test/perf
| Command | mise-2025.11.10 | mise | Variance |
|---|---|---|---|
| install (cached) | 106ms | 108ms | -1% |
| ls (cached) | 65ms | 65ms | +0% |
| bin-paths (cached) | 71ms | 71ms | +0% |
| task-ls (cached) | 424ms | 424ms | +0% |
jdx
pushed a commit
that referenced
this pull request
Nov 30, 2025
### 🚀 Features - **(backend)** add filter_bins option to github/gitlab backends by @risu729 in [#7105](#7105) - **(ci)** auto-close PRs from non-maintainers by @jdx in [#7108](#7108) - **(conda)** add conda backend for installing packages from conda-forge by @jdx in [#7139](#7139) - **(github)** add rename_exe option and switch elm, opam, yt-dlp from ubi by @jdx in [#7140](#7140) - **(install)** add --locked flag for strict lockfile mode by @jdx in [#7098](#7098) - **(lock)** implement cross-platform lockfile generation by @jdx in [#7091](#7091) - **(lockfile)** add options field for tool artifact identity by @jdx in [#7092](#7092) - **(lockfile)** add env field and local lockfile support by @jdx in [#7099](#7099) - **(lockfile)** add URL support for deno, go, and zig backends by @jdx in [#7112](#7112) - **(lockfile)** add URL support for vfox backend by @jdx in [#7114](#7114) - **(lockfile)** add multi-platform checksums without downloading tarballs by @jdx in [#7113](#7113) ### 🐛 Bug Fixes - **(backend)** allow platform-specific strip_components by @risu729 in [#7106](#7106) - **(backend)** prefer path root for bin path if it contains an executable by @risu729 in [#7151](#7151) - **(bash)** avoid deactivate error on (no)unset PROMPT_COMMAND by @scop in [#7096](#7096) - **(ci)** use updatedAt instead of createdAt for stale PR detection by @jdx in [#7109](#7109) - **(github)** search subdirectories for executables in discover_bin_paths by @jdx in [#7138](#7138) - **(lockfile)** combine api_url with asset_pattern for GitHub release URLs by @jdx in [#7111](#7111) ### 🚜 Refactor - **(lock)** simplify lockfile to always use array format by @jdx in [#7093](#7093) - **(lockfile)** use compact inline table format by @jdx in [#7141](#7141) ### 📚 Documentation - **(gitlab)** document rename_exe option also for gitlab backend by @risu729 in [#7149](#7149) - **(lockfile)** update documentation for recent lockfile changes by @jdx in [#7107](#7107) - **(node)** use config_root in _.path for pnpm example by @risu729 in [#7146](#7146) - **(registry)** add github/gitlab backends to the preferred backends list by @risu729 in [#7148](#7148) - **(registry)** add url mappings for all backends by @risu729 in [#7147](#7147) ### 📦️ Dependency Updates - update docker/metadata-action digest to c299e40 by @renovate[bot] in [#7101](#7101) - update ghcr.io/jdx/mise:alpine docker digest to 693c5f6 by @renovate[bot] in [#7102](#7102) - update ghcr.io/jdx/mise:deb docker digest to 9985cab by @renovate[bot] in [#7104](#7104) - update ghcr.io/jdx/mise:copr docker digest to 564d8e1 by @renovate[bot] in [#7103](#7103) - update rust crate ubi to 0.8.4 by @risu729 in [#7154](#7154) ### 📦 Registry - add aqua backend as primary for e1s by @jdx in [#7115](#7115) - add gem backend for bashly by @jdx in [6af6607](6af6607) - switch 1password from asdf to vfox backend by @jdx in [#7116](#7116) - add vfox backend for bfs by @jdx in [#7126](#7126) - add github backend for btrace by @jdx in [#7129](#7129) - add github backend for cf by @jdx in [#7131](#7131) - add vfox backend for bpkg by @jdx in [#7130](#7130) - switch apollo-ios from asdf to github backend by @jdx in [#7118](#7118) - add vfox backend for chromedriver by @jdx in [#7134](#7134) - switch superhtml, vespa-cli, xcsift from ubi to github backend by @jdx in [#7137](#7137) - add vfox backend for clickhouse by @jdx in [#7136](#7136) - switch chicken to vfox plugin by @jdx in [#7135](#7135) - switch chezscheme from asdf to vfox backend by @jdx in [#7132](#7132) - add vfox backend for carthage by @jdx in [#7133](#7133) - switch azure-functions-core-tools from asdf to vfox backend by @jdx in [#7128](#7128) - switch aapt2 to vfox backend by @jdx in [#7117](#7117) - switch ant to vfox backend by @jdx in [#7119](#7119) - switch asciidoctorj from asdf to vfox backend by @jdx in [#7121](#7121) - switch awscli-local to pipx backend by @jdx in [#7120](#7120) - add omnictl by @risu729 in [#7145](#7145) - remove pnpm asdf plugin from fallback by @risu729 in [#7143](#7143) - switch tanzu to github backend by @jdx in [#7124](#7124) - switch android-sdk to vfox plugin by @jdx in [#7127](#7127) - add vfox backend for ag (The Silver Searcher) by @jdx in [#7122](#7122) ### Chore - **(registry)** ignore deleted tools in test-tool workflow by @risu729 in [#7081](#7081) - **(release)** show registry section last in changelog by @jdx in [#7156](#7156) - update mise.lock with checksums by @jdx in [71e9123](71e9123) - disable cancel-in-progress for test workflow on main branch by @risu729 in [#7152](#7152) ## 📦 Aqua Registry Updates #### Updated Packages (1) - [`orf/gping`](https://github.com/orf/gping)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updates the lockfile documentation (
docs/dev-tools/mise-lock.md) to reflect the recent changes since v2025.11.10:[[tools.name]]optionsfield for backend-specific artifact identitylockedsetting for strict lockfile modeenvfield andmise.local.locksupportChanges
[[tools.name]]options,envTest plan
mise run docs🤖 Generated with Claude Code
Note
Refreshes
mise.lockdocs to use[[tools.name]]array syntax, addoptions/env, document environment-specific and local lockfiles, and introduce strictlockedmode while removing obsolete sections.[[tools.name]]array syntaxoptions,env; clarifyplatformsmetadata and platform key formatsMISE_ENVworkflow and resolution priority; showmise.test.tomlexamplemise.local.toml→mise.local.lock,--localusage and commandslockedsetting (mise settings locked=true,MISE_LOCKED=1) andmise lockURL pre-resolution workflowWritten by Cursor Bugbot for commit e6fe67f. This will update automatically on new commits. Configure here.