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

Conversation

Earlopain
Copy link
Contributor

By default the RuboCop cache directory is inside a users home directory (cache path docs).

When developing inside docker this path isn't persisted by default, meaning that when invocing rubocop inside the docker container the cache is discarded every time.

In the context of a Rails application there already exists a directory that the user should be persisting (either through a volume or just by mounting it in from the host), the tmp directory in the Rails application root. This folder contains, among other things, development secrets which should be persisted across runs so that things like sessions are still valid after a container restart.

I originally wanted to make this part of the default config but I realized that this gem isn't specific to Rails applications. So I think a mention in the readme will do instead.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.


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
Copy link
Member

Choose a reason for hiding this comment

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

This README.md describes it as yaml.

Suggested change
```yml
```yaml

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.

2 participants