Skip to content

docs: update default value of cache_key_prefix - #570

Merged
jdx merged 1 commit into
jdx:mainfrom
muzimuzhi:patch-1
Jul 23, 2026
Merged

docs: update default value of cache_key_prefix#570
jdx merged 1 commit into
jdx:mainfrom
muzimuzhi:patch-1

Conversation

@muzimuzhi

@muzimuzhi muzimuzhi commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Default cache_key_prefix was bumped from mise-v0 to mise-v1 in f1c6089.

Summary by CodeRabbit

  • Documentation
    • Updated the cache configuration example to use the mise-cache-v1 key prefix.

@muzimuzhi
muzimuzhi requested a review from jdx as a code owner July 23, 2026 15:52
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 5cfad10d-6433-4392-a25e-8fd16b12f6d8

📥 Commits

Reviewing files that changed from the base of the PR and between 5c77551 and eb5f2dc.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README cache configuration example now documents cache_key_prefix: "mise-cache-v1" instead of the previous mise-v0-based value.

Changes

Cache documentation

Layer / File(s) Summary
Update cache prefix example
README.md
The cache configuration example changes the documented prefix to mise-cache-v1.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: jdx

Poem

A rabbit hops through cached delight,
Updating prefixes crisp and bright.
mise-cache-v1 now leads the way,
In README’s example today.
One small change, then off I race!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation update about the cache_key_prefix default value change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Jul 23, 2026

Copy link
Copy Markdown

Greptile Summary

Updates the cache customization example in the README.

  • Changes the sample custom cache_key_prefix to mise-cache-v1.
  • Corrects the documented default from mise-v0 to mise-v1.

Confidence Score: 5/5

The PR appears safe to merge.

The documentation now accurately identifies mise-v1 as the default cache key prefix while retaining a valid custom-prefix example.

Important Files Changed

Filename Overview
README.md The example remains a valid non-default prefix, and the documented default now matches both action.yml and runtime behavior.

Reviews (1): Last reviewed commit: "docs: update default value of `cache_key..." | Re-trigger Greptile

@jdx
jdx merged commit fc371b7 into jdx:main Jul 23, 2026
18 checks passed
@jdx jdx mentioned this pull request Jul 23, 2026
@muzimuzhi
muzimuzhi deleted the patch-1 branch July 23, 2026 16:00
jdx added a commit that referenced this pull request Jul 24, 2026
---
## [4.2.2](https://github.com/jdx/mise-action/compare/v4.2.1..v4.2.2) -
2026-07-24

### 🐛 Bug Fixes

- **(release-plz)** exit when git-cliff produces no version bump (#566)
by [@jdx](https://github.com/jdx) in
[#566](#566)
- ensure `tar` supports Zstd (#569) by
[@JackMyers001](https://github.com/JackMyers001) in
[#569](#569)

### 📚 Documentation

- update default value of `cache_key_prefix` (#570) by
[@muzimuzhi](https://github.com/muzimuzhi) in
[#570](#570)

### New Contributors

* @muzimuzhi made their first contribution in
[#570](#570)
* @JackMyers001 made their first contribution in
[#569](#569)

<!-- generated by git-cliff -->

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Version and changelog-only release PR with no application logic
changes in the diff.
> 
> **Overview**
> **Release v4.2.2** — bumps the package version from `4.2.1` to `4.2.2`
in `package.json` and `package-lock.json`, and prepends a **4.2.2**
section to `CHANGELOG.md` (git-cliff).
> 
> That release documents fixes merged since 4.2.1: **release-plz** exits
when git-cliff reports no version bump (#566), **tar** is validated for
Zstd support before use (#569), and docs correct the default for
`cache_key_prefix` (#570). This PR does not change action runtime code
beyond the version metadata.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
5c0c95b. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: mise-en-dev <123107610+mise-en-dev@users.noreply.github.com>
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