Skip to content

Comments

docs: update cache-behavior with env_cache information#7849

Merged
jdx merged 2 commits intomainfrom
docs/cache-behavior-env-cache
Jan 27, 2026
Merged

docs: update cache-behavior with env_cache information#7849
jdx merged 2 commits intomainfrom
docs/cache-behavior-env-cache

Conversation

@jdx
Copy link
Owner

@jdx jdx commented Jan 27, 2026

Summary

  • Documents the env_cache setting in the cache-behavior docs
  • Removes outdated advice to "submit a ticket" for dynamic exec-env scripts
  • Explains how env plugins can declare themselves cacheable
  • Shows how to opt out of caching with cacheable = false
  • Clarifies in env-plugin-development.md that users must enable env_cache = true for plugin caching to work

This addresses user questions about caching for dynamic environment providers like secret managers (see discussion #3712).

🤖 Generated with Claude Code


Note

Adds comprehensive docs for environment caching and clarifies exec-env caching expectations.

  • Introduces Environment Caching section in cache-behavior.md, documenting settings.env_cache, env_cache_ttl, automatic invalidation triggers, and directive-level opt-out via cacheable = false
  • Documents how env plugins (vfox modules) declare cacheability via MiseEnv returning { cacheable = true, watch_files = [...] }, with pointers to plugin docs
  • Adds tips/notes in env-plugin-development.md that caching requires env_cache = true
  • Removes outdated guidance about submitting tickets for dynamic exec-env scripts

Written by Cursor Bugbot for commit a80d1e9. This will update automatically on new commits. Configure here.

Updates the cache-behavior docs to document the env_cache setting which
provides advanced caching for dynamic environment providers like secret
managers.

Removes outdated advice to "submit a ticket" for dynamic exec-env scripts
since mise now has proper solutions for this use case.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings January 27, 2026 12:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR documents the env_cache feature for managing environment variable caching in mise, particularly for dynamic environment providers. It removes outdated troubleshooting advice and provides clear configuration examples.

Changes:

  • Added comprehensive documentation for the env_cache setting and its TTL configuration
  • Documented cache invalidation triggers and plugin cacheability options
  • Removed outdated advice to submit tickets for dynamic exec-env scripts

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Adds notes to env-plugin-development.md explaining that users must
enable `env_cache = true` in their settings for plugin caching to work.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jdx jdx enabled auto-merge (squash) January 27, 2026 12:23
@jdx jdx merged commit 160595d into main Jan 27, 2026
37 checks passed
@jdx jdx deleted the docs/cache-behavior-env-cache branch January 27, 2026 12:23
@github-actions
Copy link

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.1.8 x -- echo 19.5 ± 0.3 18.9 21.6 1.00
mise x -- echo 19.8 ± 0.4 19.1 23.6 1.01 ± 0.02

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.1.8 env 19.1 ± 0.6 18.1 21.5 1.00
mise env 20.2 ± 0.9 18.7 26.7 1.06 ± 0.06

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.1.8 hook-env 19.4 ± 0.6 18.6 21.7 1.00
mise hook-env 20.0 ± 0.8 18.9 23.2 1.03 ± 0.05

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.1.8 ls 17.4 ± 0.6 16.5 20.0 1.00
mise ls 17.8 ± 0.7 16.8 20.8 1.03 ± 0.06

xtasks/test/perf

Command mise-2026.1.8 mise Variance
install (cached) 109ms 110ms +0%
ls (cached) 66ms 66ms +0%
bin-paths (cached) 70ms 70ms +0%
task-ls (cached) 282ms 308ms -8%

mise-en-dev added a commit that referenced this pull request Jan 28, 2026
### 🚀 Features

- **(doctor)** add backend mismatch warnings by @jdx in
[#7847](#7847)
- **(http)** add rename_exe support for archive extraction by @jdx in
[#7874](#7874)
- **(http)** send x-mise-ci header for CI environment tracking by @jdx
in [#7875](#7875)
- **(install)** auto-install plugins from [plugins] config section by
@jdx in [#7856](#7856)
- **(registry)** add vercel by @mikecurtis in
[#7844](#7844)
- **(task)** support glob patterns in task_config.includes by @jdx in
[#7870](#7870)
- **(task)** add task templates for reusable task definitions by @jdx in
[#7873](#7873)

### 🐛 Bug Fixes

- **(backend)** change registry mismatch log from info to debug by @jdx
in [#7858](#7858)
- **(ci)** use squash merge for auto-merge-release workflow by @jdx in
[7e5e71e](7e5e71e)
- **(ci)** remove --auto flag to merge immediately when CI passes by
@jdx in
[23ed2ed](23ed2ed)
- **(github)** select platform-matching provenance file for SLSA
verification by @jdx in [#7853](#7853)
- **(go)** filter out version "1" from available versions by @jdx in
[#7871](#7871)
- **(install)** skip CurDir components when detecting archive structure
by @jdx in [#7868](#7868)
- **(pipx)** ensure Python minor version symlink exists for postinstall
hooks by @jdx in [#7869](#7869)
- **(registry)** prevent duplicate -stable suffix in Flutter download
URLs by @jdx in [#7872](#7872)
- **(task)** pass env to usage parser for env-backed arguments by @jdx
in [#7848](#7848)
- **(task)** propagate MISE_ENV to child tasks when using -E flag by
@jdx in
[06ee776](06ee776)
- **(vfox-dotnet)** use os.execute() to fix Windows installation by
@prodrigues1912 in [#7843](#7843)

### 📚 Documentation

- update cache-behavior with env_cache information by @jdx in
[#7849](#7849)

### ◀️ Revert

- remove task inheritance from parent configs in monorepos by @jdx in
[#7851](#7851)
- Revert "fix(ci): remove --auto flag to merge immediately when CI
passes" by @jdx in
[0606187](0606187)

### 📦 Registry

- add mago
([aqua:carthage-software/mago](https://github.com/carthage-software/mago))
by @scop in [#7845](#7845)

### Chore

- **(ci)** auto-merge release branch into main daily at 4am CST by @jdx
in [#7852](#7852)

### New Contributors

- @mikecurtis made their first contribution in
[#7844](#7844)
- @prodrigues1912 made their first contribution in
[#7843](#7843)
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.

1 participant