README.md in drg-0.16.0 vs README.md in drg-1.0.0
- old
+ new
@@ -1,9 +1,8 @@
-# DRG
-[](https://codeclimate.com/github/ridiculous/drg)
-[](http://badge.fury.io/rb/drg)
+# DRG [](https://codeclimate.com/github/ridiculous/drg) [](http://badge.fury.io/rb/drg) [](https://travis-ci.org/ridiculous/drg)
+
A Ruby utility to help automate dependency management using Bundler. You can pin Gem versions to the current or the next
available level.
## Requirements
@@ -16,18 +15,20 @@
```
## Tasks
```bash
-rake drg:pin
-rake drg:pin:major
-rake drg:pin:minor
-rake drg:pin:patch
-rake drg:pin:latest
-rake drg:pin:patch_latest
-rake drg:pin:minor_latest
-rake drg:unpin
+% rake -T
+rake drg:pin # Pin the gems in your Gemfile to the current version in the Gemfile.lock
+rake drg:pin:major # Add the approximate major version of your gems (rails, "~> 4")
+rake drg:pin:minor # Add the approximate minor version of your gems (rails, "~> 4.2")
+rake drg:pin:patch # Add the approximate patch version of your gems (rails, "~> 4.2.3")
+rake drg:pin:latest[gem] # Pin the given gem to the latest version (defaults to all gems)
+rake drg:pin:minor_latest[gem] # Pin the given gem to the latest available patch version (defaults to all gems)
+rake drg:pin:patch_latest[gem] # Pin the given gem to the latest available minor version (defaults to all gems)
+rake drg:unpin # Unpin the gems in your Gemfile
+rake spec # Run all tests
```
### drg:pin
DRG really wants to help you manage your project's gems. But DRG doesn't want to replace Bundler. Instead, we want to build on
@@ -54,119 +55,14 @@
gem 'byebug', '5.0.0', require: false
gem 'therubyracer', '0.12.2', platforms: :ruby
gem 'drg', '0.4.1' # need this
```
-### drg:pin:minor
-
-Want to pin gems at their __minor__ version?
-
-```bash
-rake drg:pin:minor
-```
-
-This task will update your Gemfile with the approximate gem's minor version. It'll change:
-
-```ruby
-gem 'rails', '4.2.3'
-```
-
-to:
-
-```ruby
-gem 'rails', '~> 4.2'
-```
-
-### drg:pin:patch
-
-Want to pin gems at their __patch__ version?
-
-```bash
-rake drg:pin:patch
-```
-
-This task will update your Gemfile with the approximate gem's patch version. It'll change:
-
-```ruby
-gem 'rails', '4.2.3'
-```
-
-to
-
-```ruby
-gem 'rails', '~> 4.2.3'
-```
-
-This can be combined with `bundle update` to quickly update all gems to the latest version.
-
-### drg:pin:major
-
-Pins your gems at the major level:
-
- ```bash
- rake drg:pin:major
- ```
-
-### drg:pin:latest
-
-Updates each outdated gem to the latest available version:
-
- ```bash
- rake drg:pin:latest #=> updates all gems in the Gemfile
- rake drg:pin:latest[<gem>] #=> updates only the specified <gem>
- ```
-
-### drg:pin:patch_latest
-
-Updates the patch version for each outdated gem to the latest version:
-
- ```bash
- rake drg:pin:patch_latest #=> updates all gems in the Gemfile
- rake drg:pin:patch_latest[<gem>] #=> updates only the specified <gem>
- ```
-
-### drg:pin:minor_latest
-
-Same as `patch_latest` except it updates the minor version to the latest
-
- ```bash
- rake drg:pin:minor_latest #=> updates all gems in the Gemfile
- rake drg:pin:minor_latest[<gem>] #=> updates only the specified <gem>
- ```
-
-### drg:unpin
-
-Remove the versions from your Gemfile. A clean start!
-
-```bash
-rake drg:unpin
-```
-
### Automation
-I use the following bash script to update all gems to the latest [major|minor|patch] version, run all tests and then add
-the result if the specs pass or rollback the changes if they fail.
-
-```bash
-#!/bin/bash
-git add Gemfile
-for cmd in $@; do
- echo " * Updating $cmd versions"
- bundle exec rake drg:pin:${cmd}_latest
- bundle update
- bundle exec rspec . -t ~js
- if [ $? -eq 0 ]
- then
- echo " * Tests passed after updating $cmd versions. Adding Gemfile ..."
- git add Gemfile*
- else
- echo " * Tests failed after updating $cmd versions. Reverting change to Gemfile ..." >&2
- git checkout -- Gemfile*
- bundle
- exit 1
- fi
-done
-```
+I use the [bin/drg](https://github.com/ridiculous/drg/blob/master/bin/drg) bash script to update all gems to the latest
+[major|minor|patch] version, run all tests and then add the result if the specs pass or rollback the changes if they
+fail (e.g. `bin/drg patch`).
### Skipping gems
You can tell drg to ignore gems by adding an inline comment with @drg (skip|ignore|frozen)