From 997d693094f290036fdd3d62c79d4e31f403db4d Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Wed, 23 Oct 2024 21:03:11 +0530 Subject: [PATCH] Update README doc to reflect current situation --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4eb1232..e2e078e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 # .gemspec -spec.add_development_dependency "rubocop-jekyll", "~> 0.13.0" +spec.add_development_dependency "rubocop-jekyll", "~> 0.14.0" ``` and run `bundle install` @@ -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.*