summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-12-06 14:35:02 -0800
committerGitHub <noreply@github.com>2018-12-06 14:35:02 -0800
commitb740d5116bf05d28760867b140c221fb7e344f68 (patch)
tree0c9d897fc98979844b5ddbac5542624ccae8b5c6
parenteb3fd8cc699f5d92c68177f570159138c9cbebc8 (diff)
parentb57d55f826d863eb622009da645bc2c79ddd45bd (diff)
downloadmixlib-config-b740d5116bf05d28760867b140c221fb7e344f68.tar.gz
Merge pull request #71 from chef/rake
Standardize the gemfile and rakefile
-rw-r--r--.github/CODEOWNERS5
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md2
-rw-r--r--Gemfile25
-rw-r--r--Rakefile24
-rw-r--r--mixlib-config.gemspec5
5 files changed, 43 insertions, 18 deletions
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index fee8d42..2953573 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,4 +1,5 @@
# Order is important. The last matching pattern has the most precedence.
-* @chef/client-maintainers
-.expeditor/** @chef/jex-team
+* @chef/client-maintainers
+.expeditor/** @chef/jex-team
+README.md @chef/docs-team
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 441965f..29bf60c 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,7 +5,7 @@
### Issues Resolved
[List any existing issues this PR resolves, or any Discourse or
-StackOverflow discussion that's relevant]
+StackOverflow discussions that are relevant]
### Check List
diff --git a/Gemfile b/Gemfile
index b4e2a20..ba67ea8 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,3 +1,28 @@
source "https://rubygems.org"
gemspec
+
+group :docs do
+ gem "yard"
+ gem "redcarpet"
+ gem "github-markup"
+end
+
+group :test do
+ gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
+ gem "rspec", "~> 3.0"
+ gem "rake"
+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,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")
diff --git a/Rakefile b/Rakefile
index b4e6ddb..19e14b8 100644
--- a/Rakefile
+++ b/Rakefile
@@ -1,9 +1,5 @@
require "bundler"
-require "rubygems"
-require "rubygems/package_task"
-require "rdoc/task"
require "rspec/core/rake_task"
-require "mixlib/config/version"
Bundler::GemHelper.install_tasks
@@ -21,12 +17,20 @@ begin
task.options += ["--display-cop-names", "--no-color"]
end
rescue LoadError
- puts "chefstyle/rubocop is not available. gem install chefstyle to do style checking."
+ puts "chefstyle/rubocop is not available. bundle install first to make sure all dependencies are installed."
end
-RDoc::Task.new do |rdoc|
- rdoc.rdoc_dir = "rdoc"
- rdoc.title = "mixlib-config #{Mixlib::Config::VERSION}"
- rdoc.rdoc_files.include("README*")
- rdoc.rdoc_files.include("lib/**/*.rb")
+begin
+ require "yard"
+ YARD::Rake::YardocTask.new(:docs)
+rescue LoadError
+ puts "yard is not available. bundle install first to make sure all dependencies are installed."
+end
+
+task :console do
+ require "irb"
+ require "irb/completion"
+ require "mixlib/config"
+ ARGV.clear
+ IRB.start
end
diff --git a/mixlib-config.gemspec b/mixlib-config.gemspec
index 7e1afed..13d1700 100644
--- a/mixlib-config.gemspec
+++ b/mixlib-config.gemspec
@@ -24,9 +24,4 @@ Gem::Specification.new do |s|
s.license = "Apache-2.0"
s.add_dependency "tomlrb"
-
- s.add_development_dependency "rake"
- s.add_development_dependency "rspec", "~> 3.0"
- s.add_development_dependency "chefstyle"
- s.add_development_dependency "rdoc"
end