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

Add a note about caching and docker to the readme #1233

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,17 @@ require:
Now you can run `rubocop` and it will automatically load the RuboCop Rails
cops together with the standard cops.

#### Usage with Docker

When you use Docker make sure that the RuboCop [cache path](https://docs.rubocop.org/rubocop/usage/caching.html#cache-path) is mounted as a volume in order to reliably persist the cache.

If developing a Rails application there already exists a temporary directory you should be persisting anyways: `tmp` in the application root folder. You can point the RuboCop cache there:

```yml
AllCops:
CacheRootDirectory: tmp/cache
```

### Command line

```sh
Expand Down