Skip to content

docs: diagram artifact cache execution - #13068

Merged
jdx merged 1 commit into
mainfrom
codex/docs-task-cache-diagram
Sep 11, 2026
Merged

jdx merged 1 commit into
mainfrom
codex/docs-task-cache-diagram

Conversation

@jdx

@jdx jdx commented Sep 10, 2026 •

Copy link
Copy Markdown
Owner

Add an artifact-cache flow diagram showing cache-key computation, restoring a hit, and executing and saving a successful miss. Explain how this differs from timestamp freshness checks and note empty outputs, failed runs, and cache bypasses.

Built with mise run docs:build; passed scoped hk checks. Checked Mermaid rendering and readable labels in light/dark mode at 1440px and 390px, with no horizontal page overflow or browser errors.

Preview

Desktop preview

Dark mode and phone layout

Dark desktop preview

Phone preview

AI-assisted β€” Tool: Codex; model: openai/unavailable; version: unavailable.


Note

Low Risk
Documentation-only change to docs/tasks/caching.md with no runtime or configuration behavior changes.

Overview
Adds an Artifact cache flow section to the task caching guide with a Mermaid flowchart for eligible tasks: declared inputs feed cache-key computation, a hit restores outputs and replays logs without running the command, and a miss runs the task and saves results on success.

The new prose clarifies that this path is separate from modification-time freshness checks, calls out outputs = [] behavior, notes that failed runs are not cached, and points readers to per-run cache access and storage/replay for bypass and edge cases.

Reviewed by Cursor Bugbot for commit d7ecee2. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Added an β€œArtifact cache flow” section describing cache hits, misses, output restoration, log replay, and successful result storage.
    • Documented behavior for tasks with no outputs, failed runs, forced execution, disabled cache access, and ineligible tasks.

Entire-Checkpoint: 01M26VSCSE8EXJ8P66SB2DMA4W
@coderabbitai

coderabbitai Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview 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: Advanced

Run ID: ca57e836-beac-4242-b4a4-80e6daf50fb3

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between e4b5f52 and d7ecee2.

πŸ“’ Files selected for processing (1)
  • docs/tasks/caching.md

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


πŸ“ Walkthrough

Walkthrough

The caching documentation adds an β€œArtifact cache flow” section. It describes cache keys, cache hits, cache misses, successful result storage, log replay, output restoration, and bypass conditions.

Changes

Artifact cache documentation

Layer / File(s) Summary
Document artifact cache flow
docs/tasks/caching.md
Adds a Mermaid flowchart for cache lookup and execution. Documents outputs = [], failed runs, forced runs, disabled cache access, and ineligible tasks.

Priority: ⬇️ Low

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

Merge Risk: βšͺ Minimal Β· up to d7ece

The cache-flow documentation is consistent with the described behavior and introduces no runtime changes.

πŸš₯ 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 and the artifact-cache execution diagram, which matches the main pull request objective.
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…
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 Sep 10, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The documentation-only change appears safe to merge.

Summary

  • Distinguishes artifact reuse from modification-time freshness checks.
  • Illustrates cache-key computation, hit restoration, miss execution, and successful-result storage.
  • Documents empty-output behavior, failed runs, and common cache bypasses.

Reviews (1) Β· Last reviewed commit: "docs: diagram artifact cache execution"

@jdx
jdx merged commit 574e394 into main Sep 11, 2026
45 of 47 checks passed
@jdx
jdx deleted the codex/docs-task-cache-diagram branch September 11, 2026 00:22
@github-actions

Copy link
Copy Markdown
Contributor

Instruction counts

benchmark trend instructions Ξ” wall (min) Ξ”
env β–β–‚β–ƒβ–‚β–…β–…β–„β–…β–…β–†β–ˆβ–ˆ 34,983,126 β†’ 34,975,887 -0.02% 18.57 β†’ 18.98ms +2.19%
hook-env β–β–β–β–β–ˆβ–ˆβ–‡β–ˆβ–‡β–ˆβ–ˆβ–† 36,438,681 β†’ 36,324,834 -0.31% 19.66 β†’ 19.11ms -2.82%
ls β–β–‚β–β–β–ˆβ–‡β–ˆβ–‡β–‡β–†β–ˆβ–ƒ 38,917,953 β†’ 38,700,358 -0.56% 21.33 β†’ 21.52ms +0.87%
registry β–β–β–‚β–‚β–†β–†β–‡β–†β–…β–†β–ˆβ–„ 37,904,470 β†’ 37,780,768 -0.33% 16.04 β†’ 16.40ms +2.26%
startup β–β–β–β–β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆ 9,493,961 β†’ 9,480,710 -0.14% 10.99 β†’ 10.90ms -0.81%

No instruction-count regression above 1%.

Only instruction counts gate. Wall clock is shown for context β€” on identical hardware it moves 4-20% run to run.

Measured by tak β€” instruction-counted CLI benchmarks, stored in this repository's git notes.

d7ecee223904 vs e4b5f52c436c Β· measured on the runner, not pushed to the history.

jdx pushed a commit that referenced this pull request Sep 12, 2026
### πŸš€ Features

- **(bootstrap)** declare Dock applications in order by @azohra in
[#13075](#13075)
- **(brew)** implement `mise bootstrap packages where` for keg-only
packages by @himkt in [#13083](#13083)
- **(cli)** add configurable output truncation by @jdx in
[#13112](#13112)
- **(daemons)** manage project daemons and database presets with
pitchfork by @jdx in [#13085](#13085)
- **(doctor)** add project diagnostic checks by @jdx in
[#13062](#13062)
- **(dotfiles)** infer variant sources from dotfiles root by @jdx in
[#13087](#13087)
- **(fmt)** sort lists whose order carries no meaning by @jrandolf in
[#13058](#13058)
- **(vfox)** add backend tool discovery by @jdx in
[#13111](#13111)

### πŸ› Bug Fixes

- **(asdf)** avoid recursive compatibility dispatch by @jdx in
[#13114](#13114)
- **(bootstrap)** explain macos defaults type differences by @jdx in
[#13096](#13096)
- **(bootstrap)** find ssh and tar on Windows for remote bootstrap by
@JamBalaya56562 in [#13117](#13117)
- **(brew)** link keg-only-on-macOS formulae on Linux by @lil-lon in
[#13108](#13108)
- **(config)** merge monorepo settings across overlays by @jdx in
[#13084](#13084)
- **(config)** scope runtime lockfile lookup to effective tool config by
@nettlesh in [#13042](#13042)
- **(doctor)** align project check roots, dir expansion, schema, and
signals by @jdx in [#13089](#13089)
- **(dotfiles)** honor global yes setting when tracking files by
@nettlesh in [#13072](#13072)
- **(dotfiles)** warn when tracking a symlink without its source by @jdx
in [#13095](#13095)
- **(http)** make shared extraction opt-in by @jdx in
[#13059](#13059)
- **(lockfile)** allow packslip to replace legacy provenance by @jdx in
[#13105](#13105)
- **(nushell)** wrap hide-env in try instead of in-env guard by @i-api
in [#13071](#13071)
- **(packslip)** skip unsupported lockfile targets by @jdx in
[#13102](#13102)
- **(schema)** model dotfiles manifests by @risu729 in
[#12741](#12741)
- **(task)** auto-install tools for run task references by @jdx in
[#13086](#13086)
- **(upgrade)** detect letter-suffixed version updates by @jdx in
[#13119](#13119)
- extract structured flight steps from tap casks by @jdx in
[#13060](#13060)

### πŸ“š Documentation

- **(agents)** write PR titles and descriptions for release notes by
@jdx in [#13090](#13090)
- **(task)** organise task-running guidance by @azohra in
[#13077](#13077)
- diagram tracked dotfile synchronization by @jdx in
[#13069](#13069)
- diagram artifact cache execution by @jdx in
[#13068](#13068)
- diagram tool configuration precedence by @jdx in
[#13067](#13067)
- illustrate bootstrap machine resources by @jdx in
[#13066](#13066)
- illustrate project environment switching by @jdx in
[#13065](#13065)
- prevent landing tabs from shifting content by @jdx in
[#13107](#13107)
- prohibit drive-by AI discussion spam by @jdx in
[#13110](#13110)

### ⚑ Performance

- **(lockfile)** avoid scheduling cached generation targets by @jdx in
[#13101](#13101)
- **(lockfile)** skip generation for current warm installs by @jdx in
[#13103](#13103)
- **(oci)** leave same-repository base layers remote during push by @jdx
in [#13055](#13055)
- **(oci)** cache local tool layers across image builds by @jdx in
[#13056](#13056)

### πŸ“¦οΈ Dependency Updates

- update rust crate aube-registry to v2.2.14 by @renovate[bot] in
[#13015](#13015)
- update communique to v1.4.0 by @jdx in
[#13104](#13104)
- update rattler by @renovate[bot] in
[#12966](#12966)
- update rust crate aube to v2.2.14 by @renovate[bot] in
[#13014](#13014)
- update rust crate usage-lib to v6.9.0 by @renovate[bot] in
[#12892](#12892)
- update rust crate usage-cli to v6.9.0 by @renovate[bot] in
[#12891](#12891)

### πŸ“¦ Registry

- add mpv (conda:mpv) by @i-api in
[#13049](#13049)
- use conda for postgres, redis, and mongodb by @jdx in
[#13061](#13061)
- add agent-browser by @3w36zj6 in
[#13088](#13088)
- add himalaya
([github:pimalaya/himalaya](https://github.com/pimalaya/himalaya)) by
@i-api in [#13091](#13091)
- fix editorconfig-checker 4.0.1 by @jdx in
[#13098](#13098)
- fix mc downloads from MinIO releases by @jdx in
[#13113](#13113)

### Chore

- **(ci)** replace actionlint with zizmor by @jdx in
[#13097](#13097)

### Ci

- increase vfox runner memory by @jdx in
[#13118](#13118)

### New Contributors

- @lil-lon made their first contribution in
[#13108](#13108)

## πŸ“¦ Aqua Registry Updates

### New Packages (1)

- [`getgaal/gaal`](https://github.com/getgaal/gaal)

### Updated Packages (1)

- [`yadm-dev/yadm`](https://github.com/yadm-dev/yadm)
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