README.md in recent_ruby-0.1.0 vs README.md in recent_ruby-0.1.1

- old
+ new

@@ -1,14 +1,14 @@ # Recent Ruby -This script takes a Ruby version number, compares it to all available Ruby versions, and throws an error unless the supplied version number contains the latest security patches. +This script takes a Ruby version number, compares it to all available Ruby versions, and throws an error unless the supplied version number contains the latest security patches. Put it in your build pipeline and you'll never deploy an app to an unpatched Ruby again. ## Why -Heroku (and other platforms) use the Gemfile to determine which version of Ruby to use. This means, whenever a Ruby vulnerability is found, you need to personally update your Gemfile in order to be safe. This also means you need to pay close attention to the Ruby security notices. On smaller teams, this is often overlooked. +Heroku (and other platforms) use the Gemfile to determine which version of Ruby to use. This means, whenever a Ruby vulnerability is found, you need to update your Gemfile in order to be safe. More importantly it means you need to pay close attention to the Ruby security notices. On smaller teams, this is often overlooked. -For Ruby gems, you can use Brakeman or Hakiri or Github itself to stay up-to-date with security patches. For your Ruby version, you can now use Recent Ruby. +For gems, you can use Brakeman or Hakiri or Github itself to stay up-to-date with security patches. For your Ruby version, you can now use Recent Ruby. ## Installation Recent Ruby's installation is pretty standard: @@ -22,29 +22,37 @@ gem 'recent_ruby', require: false ``` ## Usage -Just add Recent Ruby in your CI/CD build process, wherever you would put Rubocop or Brakeman. Recent Ruby can check either your Gemfile, or whatever is supplied as a command line argument, and checks if that version of Ruby is the most recent TEENY/PATCH release for that minor version. It also makes sure that your minor version is not End-of-Life yet. If your version of Ruby does happen to be out of date and potentially insecure, it exits with status code 1. This means you can simply drop it into your .circle.yml or your Semaphore build step, or wherever you usually put these things. +Just add Recent Ruby in your CI/CD build process, wherever you would put Rubocop or Brakeman. Recent Ruby can check either your Gemfile, or whatever is supplied as a command line argument, and checks if that version of Ruby is the most recent TEENY/PATCH release for that minor version. +It also makes sure that your minor version is not End-of-Life yet. If your version of Ruby does happen to be out of date and potentially insecure, it exits with status code 1. This means you can simply drop it into your .circle.yml or your Semaphore build step, or wherever you usually put these things. + ## Examples -Version number supplied on command line (2.3.7 was the latest 2.3 release at the time of this writing): +Outdated version number supplied on command line (2.3.7 was the latest 2.3 release at the time of this writing): ``` $ recent_ruby --version-string 2.3.1 Downloading latest list of Rubies from Github... Comparing version numbers... Current version is 2.3.1, but the latest patch release for 2.3 is 2.3.7! +``` +Latest release for 2.3: +``` $ recent_ruby --version-string 2.3.7 Downloading latest list of Rubies from Github... Comparing version numbers... Downloading details for 2.3.7... Checking EOL status... Ruby version check completed successfully. +``` +Latest release for 2.0, which is End-of-Life (no longer getting security patches): +``` $ recent_ruby --version-string 2.0.0-p648 Downloading latest list of Rubies from Github... Comparing version numbers... Downloading details for 2.0.0-p648... Checking EOL status... @@ -65,16 +73,35 @@ Downloading latest list of Rubies from Github... Comparing version numbers... Current version is 2.3.3, but the latest patch release for 2.3 is 2.3.7! ``` +Build steps I use on in the project settings on SemaphoreCI: + +``` +# Setup: +gem install recent_ruby --no-rdoc --no-ri + +# Build: +recent_ruby --gemfile Gemfile +``` + ## How If `--gemfile` was supplied, we use the parser gem to extract the Ruby version from the Gemfile. First, we check that we’re being supplied an MRI stable release. If not, we immediately stop and error with exit code 1. Next, we grab the list of releases from the ruby-build repository and do some comparison to make sure we’re on the latest TEENY/PATCH release. Then we download the build specification from the ruby-build repository, and make sure an End-of-Life warning is not present. Since the ruby-build repository is well maintained and used in production by many, it’s a reliable source. ## Contributing -Feel free to create issues for any problems you may have. Patches are welcome, especially if they come with a Cucumber scenario. \ No newline at end of file +Feel free to create issues for any problems you may have. Patches are welcome, especially if they come with a Cucumber scenario. + +## Contributors + +- Lucas Luitjes +- Cedric Hartskeerl + +## License + +This project is MIT licensed.