Skip to content

Commit

Permalink
README.md: Document how we version new rubocop releases
Browse files Browse the repository at this point in the history
  • Loading branch information
bastelfreak committed Dec 19, 2023
1 parent 80c66c8 commit 9d87bf6
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,18 @@ used in all Vox Pupuli gems.
In your Gemfile, add the following:

```
gem 'voxpupuli-rubocop', '~> 1.1'
gem 'voxpupuli-rubocop', '~> 2.1.0'
```

**We suggest to pin the minor version like above, because new minor versions will pull in newer rubocop versions**

(A best practice, that we also follow in our Vox Pupuli Ruby Gems, is to pin
like above and use dependabot. It will provide pull requests that allow
newer minor versions. And in a CI pipeline you will see if the newer rubocop
works without issues. That prevents your HEAD branch from breaking. If you've
multiple repositories in your GitHub Org, you can filter for all dependabot PRs
by checking for `label:ruby label:dependencies` (Vox Pupuli example)[https://github.com/pulls?q=is%3Aopen+is%3Apr+archived%3Afalse+label%3Aruby+label%3Adependencies+user%3Avoxpupuli+]).

In your Rakefile, include our Rake task:

```
Expand Down

0 comments on commit 9d87bf6

Please sign in to comment.