Skip to content

Commit

Permalink
Update README doc to reflect current situation
Browse files Browse the repository at this point in the history
  • Loading branch information
ashmaroli authored Oct 23, 2024
1 parent 57ab76c commit 997d693
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
A RuboCop extension to enforce common code style in Jekyll and Jekyll plugins.


[![Gem Version](https://img.shields.io/gem/v/rubocop-jekyll.svg?label=Latest%20Release)][rubygems]
[![RuboCop Support](https://img.shields.io/badge/RuboCop%20Support-1.45.x-green.svg)][rubocop-releases]
[![Gem Version](https://img.shields.io/gem/v/rubocop-jekyll.svg?label=Latest%20Release&labelColor=000000&style=for-the-badge&logo=rubygems&logoColor=white&color=E9573F)][rubygems]
[![RuboCop Support](https://img.shields.io/badge/RuboCop%20Support-1.57.x-AA0000.svg?style=for-the-badge&labelColor=000000&logo=rubocop)][rubocop-releases]
![Targeted Ruby Version](https://img.shields.io/badge/Targeted%20Ruby%20Version-2.7.x-CC342D.svg?style=for-the-badge&labelColor=000000&logo=ruby)

[rubygems]: https://rubygems.org/gems/rubocop-jekyll
[rubocop-releases]: https://github.com/rubocop-hq/rubocop/releases
Expand All @@ -23,12 +24,12 @@ or if you prefer Bundler, add it to your `Gemfile` or `gemspec`
```ruby
# Gemfile

gem "rubocop-jekyll", "~> 0.13.0"
gem "rubocop-jekyll", "~> 0.14.0"
```
```ruby
# <plugin>.gemspec

spec.add_development_dependency "rubocop-jekyll", "~> 0.13.0"
spec.add_development_dependency "rubocop-jekyll", "~> 0.14.0"
```
and run `bundle install`

Expand Down Expand Up @@ -56,12 +57,13 @@ You can override any settings inherited from the extension by subsequently redef

## Release Cycle

A new release of this gem is manually cut based on the adoption of the latest version of RuboCop by the [Jekyll repository](https://github.com/jekyll/jekyll):
A new release of this gem is cut based on the adoption of the latest version of RuboCop by the [Jekyll repository](https://github.com/jekyll/jekyll):

1. RuboCop releases a new version.
2. The `master` branch of Jekyll repository is updated to the latest RuboCop version along with any updates to their `.rubocop.yml`.
3. The RuboCop version and `.rubocop.yml` at this gem's repository is updated **via a pull request**.
4. A new minor release is subsequently cut and shipped.
3. The RuboCop version, and `.rubocop.yml` at this gem's repository is updated **via a pull request**.
4. Files `lib/rubocop-jekyll/version.rb` and `README.md` at this gem's repository is updated **via a pull request**.
5. A new minor release is subsequently cut and automatically shipped via GitHub Actions.

*Note: A patch version of this gem will be released if Jekyll repository updates their `.rubocop.yml` independently of
a RuboCop version bump.*

0 comments on commit 997d693

Please sign in to comment.