Skip to content

docs(env): fix cacheable source example - #12278

Merged
jdx merged 1 commit into
jdx:mainfrom
Marukome0743:pr12278
Aug 23, 2026
Merged

jdx merged 1 commit into
jdx:mainfrom
Marukome0743:pr12278

Conversation

@Marukome0743

@Marukome0743 Marukome0743 commented Aug 22, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • correct the cacheable _.source example to use the supported path field
  • keep the example aligned with the current environment directive schema

Problem

The cache behavior documentation used file inside _.source, but the source directive accepts path. Copying the documented example therefore fails configuration deserialization instead of sourcing dynamic.sh.

Verification

  • mise exec -- prettier --check docs/cache-behavior.md — passed
  • mise run docs:build — blocked by an unrelated existing Vue compiler failure in docs/cli/tool-alias/set.md: decode.fromCodePoint is not a function
  • mise run lint — blocked locally because hk could not detect the Git repository in this Sapling checkout

Addresses #8735

AI-assisted — Tool: Codex; model: openai/unavailable; version: unavailable.

Summary by CodeRabbit

  • Documentation
    • Updated the _.source directive example to use the path attribute.
    • Clarified that cacheable = false remains supported.

@coderabbitai

coderabbitai Bot commented Aug 22, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 4fe225c4-18ab-4f96-bcde-fb3ca576ae6c

📥 Commits

Reviewing files that changed from the base of the PR and between 6f52dcd and d981a99.

📒 Files selected for processing (1)
  • docs/cache-behavior.md

Included review availability: Your plan provides up to 10 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The cache behavior documentation updates the _.source example to use path instead of file. The example retains cacheable = false.

Changes

Cache behavior documentation

Layer / File(s) Summary
Update source path example
docs/cache-behavior.md
The _.source example now uses the path attribute and retains cacheable = false.

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

Merge Risk: ⚪ Minimal · up to d981a

This localized documentation fix corrects the cacheable source example without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: jdx

Poem

A rabbit hops through cached code,
And finds the right path on the road.
file rests beneath the tree,
While false keeps caching quiet and free.
Documentation blooms with glee.

🚥 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 identifies the documentation change to the cacheable source example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
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 Aug 22, 2026 •

Copy link
Copy Markdown
Contributor

Greptile Summary

Corrects the cache behavior documentation so the _.source example uses the current path field.

  • Replaces the unsupported file key with path in docs/cache-behavior.md.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/cache-behavior.md Updates the source-directive example to use the schema-supported path field.

Reviews (2): Last reviewed commit: "docs(env): fix cacheable source example" | Re-trigger Greptile

@github-actions

Copy link
Copy Markdown
Contributor

This PR currently has failing checks. If this continues for 7 days, it will be closed automatically.

This is warning day 1 of 7.

Please update the PR when you have a chance. Feel free to reopen or create a new PR if it is closed and you'd like to continue working on it.

This comment was generated by an automated workflow.

@Marukome0743
Marukome0743 marked this pull request as ready for review August 23, 2026 01:59
@jdx
jdx merged commit b90ce5e into jdx:main Aug 23, 2026
30 checks passed
@Marukome0743
Marukome0743 deleted the pr12278 branch August 23, 2026 02:28
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