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.

Sign up for GitHub

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

Jump to bottom

README.md: Document how we version new rubocop releases #45

Merged
merged 1 commit into from Dec 19, 2023
Merged

README.md: Document how we version new rubocop releases #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
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