summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-09-09 11:24:54 -0700
committerTim Smith <tsmith@chef.io>2018-09-09 11:24:54 -0700
commit1e20788e2dc315e8ebf8331ca6abfba24d0d7605 (patch)
treecd297753d877a08dd017d88fde2be3ccaeda7b7b
parent901d003e42839145fe099172a6c56d2432c824ad (diff)
downloadohai-rakefile.tar.gz
More rake / Travis updatesrakefile
Add the gem groups, speed up Travis installs, update the readme tasks documentation. Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--.travis.yml3
-rw-r--r--Gemfile13
-rw-r--r--README.md15
3 files changed, 25 insertions, 6 deletions
diff --git a/.travis.yml b/.travis.yml
index 171aa74b..25a09de6 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,6 +1,5 @@
language: ruby
cache: bundler
-dist: trusty
sudo: false
@@ -9,6 +8,8 @@ branches:
- master
- 13-stable
+bundler_args: --jobs 7 --without docs debug
+
before_install:
- gem --version
- rvm @global do gem uninstall bundler -a -x -I || true
diff --git a/Gemfile b/Gemfile
index c78891c8..29f522eb 100644
--- a/Gemfile
+++ b/Gemfile
@@ -17,6 +17,19 @@ group :ci do
gem "rspec_junit_formatter"
end
+group :docs do
+ gem "yard"
+ gem "redcarpet"
+ gem "github-markup"
+end
+
+group :debug do
+ gem "pry"
+ gem "pry-byebug"
+ gem "pry-stack_explorer"
+ gem "rb-readline"
+end
+
instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
# If you want to load debugging tools into the bundle exec sandbox,
diff --git a/README.md b/README.md
index 626f596e..b0796bce 100644
--- a/README.md
+++ b/README.md
@@ -37,11 +37,16 @@ Ohai has some Rake tasks for doing various things.
```
rake -T
-rake build # Build the gem file ohai-$VERSION.gem
-rake install # install the gem locally
-rake install:local # install the gem locally without network access
-rake release # Create tag $VERSION, build gem, and push to Rubygems
-rake spec # Run RSpec tests
+rake build # Build ohai-$VERSION.gem into the pkg directory
+rake clean # Remove any temporary products
+rake clobber # Remove any generated files
+rake docs # Generate YARD Documentation
+rake install # Build and install ohai-$VERSION.gem into system gems
+rake install:local # Build and install ohai-$VERSION.gem into system gems without network access
+rake release[remote] # Create tag $VERSION and build and push ohai-$VERSION.gem to rubygems.org
+rake spec # Run RSpec code examples
+rake style # Run Chefstyle tests
+rake style:auto_correct # Auto-correct RuboCop offenses
($VERSION is the current version, from the GemSpec in Rakefile)
```