From 3ddb71c77b0f124ab541a4b9644c18a8409a3172 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Oct 2018 18:54:41 -0700 Subject: Test on modern ruby releases in Travis Signed-off-by: Tim Smith --- .travis.yml | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.travis.yml b/.travis.yml index de8b4fa..cab23f0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,12 +1,20 @@ +sudo: false language: ruby cache: bundler -sudo: false -rvm: - - 2.0 - - 2.1 - - 2.2 +matrix: + include: + - rvm: 2.3.7 + - rvm: 2.4.4 + - rvm: 2.5.3 + - rvm: ruby-head + allow_failures: + - rvm: ruby-head + +branches: + only: + - master -bundler_args: --jobs 7 +bundler_args: --jobs 7 --without docs debug script: bundle exec rspec --color --format progress -- cgit v1.2.1 From d69ec8252be824d7ba14297d1af10f3a327a18d2 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Oct 2018 18:55:15 -0700 Subject: Add github PR/issue templates and a codeowners file Signed-off-by: Tim Smith --- .github/CODEOWNERS | 4 ++++ .github/ISSUE_TEMPLATE.md | 12 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 3 files changed, 30 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..fee8d42 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# Order is important. The last matching pattern has the most precedence. + +* @chef/client-maintainers +.expeditor/** @chef/jex-team diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..90c720d --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,12 @@ +## Description + + +## Gem Version + + +## Windows Version + + +## Replication Case + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..29bf60c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +### Description + +[Please describe what this change achieves] + +### Issues Resolved + +[List any existing issues this PR resolves, or any Discourse or +StackOverflow discussions that are relevant] + +### Check List + +- [ ] New functionality includes tests +- [ ] All tests pass +- [ ] All commits have been signed-off for the Developer Certificate of Origin. See -- cgit v1.2.1 From f0afc701e5640c7f364c7ae49b7db17214672a46 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Oct 2018 18:56:01 -0700 Subject: Add standard rake tasks Signed-off-by: Tim Smith --- Gemfile | 21 ++++++++++++++++++++- Rakefile | 14 ++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 851fabc..3f0c104 100644 --- a/Gemfile +++ b/Gemfile @@ -1,2 +1,21 @@ -source 'https://rubygems.org' +source "https://rubygems.org" + gemspec + +group :docs do + gem "yard" + gem "redcarpet" + gem "github-markup" +end + +group :debug do + gem "pry" + gem "pry-byebug" + gem "pry-stack_explorer" +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 c702cfc..c71976d 100644 --- a/Rakefile +++ b/Rakefile @@ -1 +1,15 @@ require 'bundler/gem_tasks' + +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" + ARGV.clear + IRB.start +end -- cgit v1.2.1 From f8e749876111e632ac926c0c95b52ed9e55fa992 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Oct 2018 18:56:19 -0700 Subject: Remove dev deps from the gemspec Signed-off-by: Tim Smith --- wmi-lite.gemspec | 2 -- 1 file changed, 2 deletions(-) diff --git a/wmi-lite.gemspec b/wmi-lite.gemspec index 3d2482f..9b4825c 100644 --- a/wmi-lite.gemspec +++ b/wmi-lite.gemspec @@ -26,6 +26,4 @@ Gem::Specification.new do |spec| spec.add_development_dependency 'bundler', '~> 1.3' spec.add_development_dependency 'rspec' spec.add_development_dependency 'rake' - spec.add_development_dependency 'pry' - spec.add_development_dependency 'pry-byebug' end -- cgit v1.2.1 From 1fb606af834f6d01e1c225712f8283a883766e63 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Oct 2018 18:56:44 -0700 Subject: Move contributing information to the readme Signed-off-by: Tim Smith --- CHANGELOG.md | 6 +----- CONTRIBUTING.md | 5 ----- README.md | 34 ++++++++++++++++++++++------------ 3 files changed, 23 insertions(+), 22 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 1651ff8..672042b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,6 @@ # WMI-Lite Change Log -## Unreleased -* Initial implementation - -Last Release: v1.0.0 (2014-05-15) -------------------- +## [v1.0.0](https://github.com/chef/wmi-lite/tree/v1.0.0) (2014-05-15) - First public release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 0849724..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing to WMI-Lite - -We are glad you want to contribute to WMI-Lite. Please see contribution guidelines for -[Chef](https://docs.chef.io/community_contributions.html) for information on contributing to this project. - diff --git a/README.md b/README.md index 0c9118f..4191a30 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Wmi-Lite -======== +# Wmi-Lite [![Build Status](https://travis-ci.org/chef/wmi-lite.svg?branch=master)](https://travis-ci.org/chef/wmi-lite) [![Gem Version](https://badge.fury.io/rb/wmi-lite.svg)](https://badge.fury.io/rb/wmi-lite) @@ -9,15 +8,14 @@ Wmi-Lite functionality on Windows. It has no dependencies outside of the Ruby interpreter and libraries and of course the Windows operating system. -Installation ------------- +## Installation To install it, run: gem install wmi-lite -Usage ------ +## Usage + To use `wmi-lite` in your Ruby source code, just `require` it: ```ruby @@ -93,13 +91,25 @@ end puts ``` -License & Authors ------------------ -Author:: Adam Edwards () -Copyright:: Copyright (c) 2014-2015 Chef Software, Inc. -License:: Apache License, Version 2.0 +## Development Documentation + +All documentation is written using YARD. You can generate a by running: + +``` +rake docs +``` + +## Contributing +For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md) + +## License & Copyright + +- Copyright:: Copyright (c) 2014-2018 Chef Software, Inc. +- License:: Apache License, Version 2.0 + +```text Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -111,4 +121,4 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - +``` -- cgit v1.2.1 From f1548afdeacdea540e04c8d1d09381bba14bd5fb Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Oct 2018 18:57:04 -0700 Subject: Update the homepage and use a SPDX compliant license string Signed-off-by: Tim Smith --- wmi-lite.gemspec | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/wmi-lite.gemspec b/wmi-lite.gemspec index 9b4825c..7c473c7 100644 --- a/wmi-lite.gemspec +++ b/wmi-lite.gemspec @@ -15,8 +15,8 @@ Gem::Specification.new do |spec| 'without concerns around dependency issues.' spec.summary = 'A lightweight utility library for accessing basic WMI ' \ '(Windows Management Instrumentation) functionality on Windows' - spec.homepage = 'https://github.com/opscode/wmi-lite' - spec.license = 'Apache 2.0' + spec.homepage = 'https://github.com/chef/wmi-lite' + spec.license = 'Apache-2.0' spec.files = `git ls-files`.split($/) spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } -- cgit v1.2.1