Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of cache-directories #218

Open
rukai opened this issue Nov 12, 2024 · 0 comments
Open

Improve documentation of cache-directories #218

rukai opened this issue Nov 12, 2024 · 0 comments

Comments

@rukai
Copy link
Contributor

rukai commented Nov 12, 2024

The documentation for cache-directories says:

    # Additional non workspace directories to be cached, separated by newlines.
    cache-directories: ""

From reading this, two things aren't clear to me:

1

What exactly is meant by "newlines".

Can I do something like this:

   cache-directories: |
     entry1
     entry2

Or do I need to do something like this:

   cache-directories: "entry1\nentry2"

An example in the docs would be great, otherwise an example in https://github.com/Swatinem/rust-cache/tree/master/.github/workflows could be an alternative.

2

Does "non workspace" mean directories outside of the target folder?
If I do specify such "non workspace" directories does rust-cache just ignore them?

@rukai rukai changed the title Improve documentation of `cache-directories Improve documentation of cache-directories Nov 12, 2024
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

No branches or pull requests

1 participant