Skip to content

docs(config): clarify always_keep_download behavior#9235

Merged
jdx merged 1 commit intojdx:mainfrom
risu729:docs/always-keep-download-debug
Apr 18, 2026
Merged

docs(config): clarify always_keep_download behavior#9235
jdx merged 1 commit intojdx:mainfrom
risu729:docs/always-keep-download-debug

Conversation

@risu729
Copy link
Copy Markdown
Contributor

@risu729 risu729 commented Apr 18, 2026

Summary

  • clarify that always_keep_download is for debugging preserved install downloads, not a reusable download cache
  • update the downloads directory docs to state preserved files are not reused for future installs
  • regenerate schema/mise.json with the revised setting description

Closes discussion context: #8654

Tests

  • mise run render:schema
  • git diff --check

This PR was generated by an AI coding assistant.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates documentation across several files to clarify that the always_keep_download setting is intended for debugging rather than as a persistent cache. The review feedback identifies potential inaccuracies regarding file reuse behavior and the timing of directory cleanup, and suggests retaining information about default behavior in configuration examples.

Comment thread docs/directories.md Outdated
Comment thread settings.toml Outdated
Comment thread docs/configuration.md Outdated
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 18, 2026

Greptile Summary

This documentation-only PR clarifies that always_keep_download is a debugging aid for inspecting retained download artifacts, not a reusable download cache, and adds guidance directing users who want CI/offline caching to the ~/.local/share/mise/installs directory instead. The changes are consistent across settings.toml (new docs block), docs/directories.md (updated directory description), docs/configuration.md (inline comment tweak), and a regenerated schema/mise.json.

Confidence Score: 5/5

Safe to merge — documentation-only change with no code modifications.

All four changed files are documentation/schema. The new wording is accurate, internally consistent, and addresses a genuine user misconception. No logic or runtime behavior is affected.

No files require special attention.

Important Files Changed

Filename Overview
settings.toml Added a detailed docs block for always_keep_download clarifying it is a debug aid, not a reusable cache, and suggesting caching ~/.local/share/mise/installs instead
docs/directories.md Updated the ~/.local/share/mise/downloads section to state files are not reused as a cache and to recommend caching installs for CI workflows
docs/configuration.md Inline comment for always_keep_download updated from # deleted after install to # deleted after install; not a cache for clarity
schema/mise.json Schema regenerated via mise run render:schema; the always_keep_download short description is unchanged (only the longer docs block was edited in settings.toml, which does not appear in the schema)

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[mise install] --> B[Download to ~/.local/share/mise/downloads]
    B --> C{always_keep_download?}
    C -- false default --> D[Delete download after install]
    C -- true --> E[Keep for debugging only]
    E --> F[Not reused on next install]
    A --> G[Install to ~/.local/share/mise/installs]
    G --> H[Cache this dir for CI/offline reuse]
Loading

Reviews (2): Last reviewed commit: "docs(config): clarify always_keep_downlo..." | Re-trigger Greptile

@risu729 risu729 force-pushed the docs/always-keep-download-debug branch from 4bb1ba8 to f4d094b Compare April 18, 2026 06:38
@risu729 risu729 marked this pull request as ready for review April 18, 2026 06:40
@jdx jdx merged commit f1ec867 into jdx:main Apr 18, 2026
35 checks passed
@risu729 risu729 deleted the docs/always-keep-download-debug branch April 18, 2026 11:09
jdx pushed a commit that referenced this pull request Apr 18, 2026
### 🐛 Bug Fixes

- **(backend)** respect install_before in latest lookup by @risu729 in
[#9193](#9193)
- **(backend)** route explicit latest through stable lookup by @risu729
in [#9228](#9228)
- **(backends)** deprecate b shorthand by @risu729 in
[#9234](#9234)
- **(config)** warn for deprecated env keys by @risu729 in
[#9205](#9205)
- **(config)** treat enable_tools empty as disable-all by @risu729 in
[#9108](#9108)
- **(github)** avoid auth on release asset downloads by @risu729 in
[#9060](#9060)
- **(gitlab)** warn when glab OAuth2 token is expired by @stanhu in
[#9195](#9195)
- **(npm)** honor install_before without day drift by @risu729 in
[#9157](#9157)
- **(npm)** warn on old bun and pnpm for install_before by @risu729 in
[#9232](#9232)
- **(pipx)** honor install_before for uv and pipx installs by @risu729
in [#9190](#9190)
- **(registry)** allow shfmt on Windows by @zeitlinger in
[#9191](#9191)

### 🚜 Refactor

- **(backend)** remove unused rolling release helper by @risu729 in
[#9175](#9175)
- **(backend)** use file util for removals by @risu729 in
[#9206](#9206)

### 📚 Documentation

- **(config)** clarify always_keep_download behavior by @risu729 in
[#9235](#9235)
- **(configuration)** add rust to idiomatic version files by @jjt in
[#9233](#9233)
- **(contributing)** expand contribution guide introduction by
@marianwolf in [#9208](#9208)
- **(github)** document multiple release assets workaround by @risu729
in [#9236](#9236)

### 📦️ Dependency Updates

- update actions/setup-node action to v6 by @renovate[bot] in
[#9183](#9183)
- update dependency @types/node to v25 by @renovate[bot] in
[#9187](#9187)
- update crazy-max/ghaction-import-gpg action to v7 by @renovate[bot] in
[#9186](#9186)
- update actions/cache action to v5 by @renovate[bot] in
[#9181](#9181)
- update amannn/action-semantic-pull-request action to v6 by
@renovate[bot] in [#9184](#9184)
- update apple-actions/import-codesign-certs action to v6 by
@renovate[bot] in [#9185](#9185)
- update dependency eslint to v10 by @renovate[bot] in
[#9200](#9200)
- update dependency toml to v4 by @renovate[bot] in
[#9201](#9201)
- update rust crate reqwest to 0.13 by @renovate[bot] in
[#9171](#9171)
- update ghcr.io/jdx/mise:deb docker digest to 523d826 by @renovate[bot]
in [#9198](#9198)
- update ghcr.io/jdx/mise:alpine docker digest to 05617e0 by
@renovate[bot] in [#9196](#9196)
- update ghcr.io/jdx/mise:rpm docker digest to c1992f9 by @renovate[bot]
in [#9199](#9199)
- update ghcr.io/jdx/mise:copr docker digest to 90db6cd by
@renovate[bot] in [#9197](#9197)
- update taiki-e/install-action digest to 58e8625 by @renovate[bot] in
[#9209](#9209)
- update fedora docker tag to v45 by @renovate[bot] in
[#9213](#9213)
- update docker/setup-buildx-action action to v4 by @renovate[bot] in
[#9212](#9212)
- update docker/metadata-action action to v6 by @renovate[bot] in
[#9211](#9211)
- update docker/login-action action to v4 by @renovate[bot] in
[#9210](#9210)
- update dependency typescript to v6 by @renovate[bot] in
[#9202](#9202)
- update docker/build-push-action action to v7 by @renovate[bot] in
[#9203](#9203)
- update github artifact actions (major) by @renovate[bot] in
[#9215](#9215)
- update rust crate duct to v1 by @renovate[bot] in
[#9220](#9220)
- update rust crate demand to v2 by @renovate[bot] in
[#9219](#9219)
- update rust crate clx to v2 by @renovate[bot] in
[#9218](#9218)
- update nick-fields/retry action to v4 by @renovate[bot] in
[#9217](#9217)
- update jdx/mise-action action to v4 by @renovate[bot] in
[#9216](#9216)
- update rust crate self_update to 0.44 by @renovate[bot] in
[#9174](#9174)
- migrate eslint config to flat format for v10 compat by @jdx in
[#9222](#9222)
- update actions/checkout action to v6 by @renovate[bot] in
[#9182](#9182)
- update rust crate toml to v1 by @renovate[bot] in
[#9225](#9225)
- update rust crate versions to v7 by @renovate[bot] in
[#9226](#9226)
- update rust crate which to v8 by @renovate[bot] in
[#9227](#9227)
- update rust crate rmcp to v1 by @renovate[bot] in
[#9221](#9221)

### 📦 Registry

- add sheldon by @3w36zj6 in
[#9104](#9104)
- add pocketbase by @ranfdev in
[#9123](#9123)
- add worktrunk ([aqua:max-sixty/worktrunk,
cargo:worktrunk](https://github.com/max-sixty/worktrunk,
cargo:worktrunk))#1 by @edouardr in
[#8796](#8796)
- add dependency-check
([aqua:dependency-check/DependencyCheck](https://github.com/dependency-check/DependencyCheck))
by @kapitoshka438 in [#9204](#9204)
- add janet by @ranfdev in
[#9241](#9241)

### New Contributors

- @ranfdev made their first contribution in
[#9241](#9241)
- @jjt made their first contribution in
[#9233](#9233)
- @marianwolf made their first contribution in
[#9208](#9208)
- @edouardr made their first contribution in
[#8796](#8796)

## 📦 Aqua Registry Updates

#### New Packages (3)

- [`LargeModGames/spotatui`](https://github.com/LargeModGames/spotatui)
-
[`android-sms-gateway/cli`](https://github.com/android-sms-gateway/cli)
- [`velero-io/velero`](https://github.com/velero-io/velero)

#### Updated Packages (1)

- [`skim-rs/skim`](https://github.com/skim-rs/skim)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants