Skip to content

[Docs] Clarify 'cached' input behavior and usage with actions/cache #96

@Maoyao233

Description

@Maoyao233

Problem

I recently encountered a confusion regarding the cached input. Based on the name and common practices in other setup actions (like setup-python or setup-uv), I assumed that setting cached: true would enable internal caching management (saving and restoring the LLVM installation).

However, when I set cached: true without external setup, the action failed because the installation directory was empty.

Investigation

After reading the source code, I realized that the cached input functions more like a skip_install flag. It tells the action: "Trust me, the files are already there, just set up the environment variables." It does not perform the actual caching logic (save/restore) itself.

Suggestion

It would be extremely helpful to clarify this in the README.md.

Currently, the documentation doesn't explicitly state that users must use actions/cache (or similar) preceding this action to actually handle the file persistence.

I suggest adding a "Caching" section to the documentation with a working example showing how to pair this action with actions/cache.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions