Skip to content

docs(README): fix cache_dependency_path type - #257

Merged
zkochan merged 3 commits into
pnpm:masterfrom
haines:fix-cache_dependency_path-docs
May 11, 2026
Merged

docs(README): fix cache_dependency_path type#257
zkochan merged 3 commits into
pnpm:masterfrom
haines:fix-cache_dependency_path-docs

Conversation

@haines

@haines haines commented May 11, 2026

Copy link
Copy Markdown
Contributor

Fixes #218

The README indicates that cache_dependency_path can be an array of strings, but multiple paths should be provided as a newline-delimited string rather than an array.

Summary by CodeRabbit

  • Documentation
    • Clarified cache_dependency_path input: documented as a single string (default pnpm-lock.yaml), accepts multiple lockfile paths separated by newlines, and explains the cache key is derived from the specified lockfile(s) contents hash.
    • Added a README YAML example demonstrating caching using multiple newline-delimited lockfiles and corresponding install commands per directory.

Review Change Stack

@haines
haines requested a review from zkochan as a code owner May 11, 2026 12:38
@coderabbitai

coderabbitai Bot commented May 11, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b42a7ae8-c4d0-46bb-9edc-27183f7ea6b2

📥 Commits

Reviewing files that changed from the base of the PR and between db33b71 and 81dbb79.

📒 Files selected for processing (1)
  • action.yml
✅ Files skipped from review due to trivial changes (1)
  • action.yml

📝 Walkthrough

Walkthrough

The PR updates README.md and action.yml for the cache_dependency_path input: documents the input as a single string (default pnpm-lock.yaml), clarifies the cache key is computed from the lockfile contents hash, and adds an example showing newline-delimited multiple lockfile paths with corresponding installs.

Changes

Input Parameter Documentation

Layer / File(s) Summary
Manifest input wording update
action.yml
Clarifies cache_dependency_path description uses "whose contents hash" for the cache key wording.
Input docs update
README.md
cache_dependency_path type changed from string|string[] to string; documents default pnpm-lock.yaml, states cache key is derived from pnpm lockfile contents hash, and documents support for multiple lockfile paths separated by newlines. Adds a YAML example showing newline-delimited cache_dependency_path and corresponding run_install per cwd.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Poem

🐰
I hopped through lines of docs tonight,
One string now, the wording right,
pnpm locks hashed, in tidy rows,
Newline paths where the solution grows,
A tiny hop for smoother flows.

🚥 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 accurately summarizes the main change: fixing the documented type of cache_dependency_path from string|string[] to string in the README.
Linked Issues check ✅ Passed The PR successfully addresses all requirements from issue #218: it corrects the type documentation from string|string[] to string and documents support for newline-delimited multi-path strings.
Out of Scope Changes check ✅ Passed The PR includes only documentation updates to README.md and action.yml related to cache_dependency_path, directly addressing the linked issue with no extraneous changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 51: Summary: Fix grammatical error in the README description by replacing
the incorrect relative pronoun phrase. Update the sentence that starts
"**Optional** (_type:_ `string`, _default:_ `pnpm-lock.yaml`) File path to the
pnpm lockfile, which contents hash will be used as a cache key." and change
"which contents hash" to "whose contents' hash" (i.e., make it read "...pnpm
lockfile, whose contents' hash will be used as a cache key.") so the possessive
is correct.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 53289321-08e9-4fde-9ee8-5b9dc79bb1f5

📥 Commits

Reviewing files that changed from the base of the PR and between 739bfe4 and 85cca29.

📒 Files selected for processing (1)
  • README.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Smoke (windows / v9.15.5)
🧰 Additional context used
🪛 LanguageTool
README.md

[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ectory. ### cache_dependency_path Optional (type: string, default: `pnpm-l...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[grammar] ~51-~51: Ensure spelling is correct
Context: ....yaml`) File path to the pnpm lockfile, which contents hash will be used as a cache k...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

Comment thread README.md Outdated
@haines
haines force-pushed the fix-cache_dependency_path-docs branch from 85cca29 to ae94e4f Compare May 11, 2026 12:42
@haines
haines force-pushed the fix-cache_dependency_path-docs branch from ae94e4f to ae488f7 Compare May 11, 2026 12:43
Comment thread README.md
@haines
haines requested a review from zkochan May 11, 2026 13:53
@zkochan
zkochan merged commit 551b42e into pnpm:master May 11, 2026
37 of 38 checks passed
@haines
haines deleted the fix-cache_dependency_path-docs branch May 11, 2026 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants