summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Fix minor typosspellingTim Smith2020-07-281-5/+5
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Add windows PR testing with Buildkitewindows_testingTim Smith2019-07-221-1/+1
| | | | | | The road to complete platform testing. Signed-off-by: Tim Smith <tsmith@chef.io>
* Add buildkite readme badgerakeTim Smith2019-06-101-1/+2
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* [MIXLIB-CLI-63] Add deprecated_option supportMarc A. Paradise2019-06-061-14/+120
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds deprecated option support by exposing a new ClassMethod, `deprecated_option`. It will generate a corresponding deprecated option, and if that option is used it will handle mapping of the old option to the new and issue a warning. `deprecated_option` accepts a subset of the parameters that `option` accepts. Most importantly, a deprecated option can't have a default value. There's a practical reason for this and a philosophical one. Practically, it makes it easy to track the situation where someone has set `use_separate_defaults` to `false`. In that case, we currently can't tell whether the user provided the flag, or it was set as a default. This could have been addressed, but: Philosphically it makes more sense to not have a default value on a deprecated item. If it's deprecated, you want people to stop using it. If it has a default, it's effectively forced in-use at all times. See function docs for further accepted parameters. To allow deprecated options without warnings, use parse_options as `parse_options(ARGV, show_deprecations: false)`. By default, warnings will be shown. This also moves some formatting code into its own class - it was causing methods to get mixed in that client classes didn't need; and I reached the point where I needed to access the formatting functions across methods in both Mixlib::CLI and Mixlib::CLI::ClassMethods. It made more sense to move them outside of the mixed-in bits, since it wasn't a concern of the caller that would be inheriting those methods. Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
* Disable Travis testing & Update codeownersTim Smith2019-05-311-1/+9
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Lint the example codeTim Smith2018-09-181-19/+19
| | | | | | Remove Ruby 1.8 style hashes Signed-off-by: Tim Smith <tsmith@chef.io>
* Fix the yard rake task nameTim Smith2018-07-301-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Move dev deps to the Gemfile and add console taskTim Smith2018-07-301-1/+9
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Add contributing docs linkTim Smith2018-07-241-3/+7
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Update copyrightsTim Smith2018-07-241-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Remove require rubygemsTim Smith2018-07-241-1/+0
| | | | | | This hasn't been required for a long time Signed-off-by: Tim Smith <tsmith@chef.io>
* Fixing example so it runs correctly when copy-pastaedTyler Ball2017-07-101-1/+1
|
* Fix README.md options formattingjr/readme-fixJordan Running2016-03-281-3/+3
|
* Add license section to the readmetas50/cleanupTim Smith2016-03-161-0/+19
|
* Convert the readme to markdownTim Smith2016-03-161-0/+90