README.md in puppetlabs_spec_helper-2.14.1 vs README.md in puppetlabs_spec_helper-2.15.0

- old
+ new

@@ -57,11 +57,11 @@ ControlPath ~/.ssh/ssh-%r@%h:%p ControlPersist yes ``` -Note: parallel downloads is only available for repositories and not forge modules. +Note: parallel downloads are available for repositories and forge modules. ### Parallel tests It is also possible to use the `parallel_tests` Gem via the `:parallel_spec` Rake task to run rspec commands in parallel on groups of spec files. Use of parallelization at this level can result in large performance benefits when the Rspec examples tend to cause a number of large, CPU-intensive catalog compilations to occur. An example of where this might be the case is in a complex module with a lot of tests or a control repo with many hosts. @@ -154,11 +154,11 @@ the equivalent of setting [parser=future](https://puppet.com/docs/puppet/3.8/configuration.html#parser) in puppet.conf. * ``TRUSTED_NODE_DATA`` _(Puppet 3.x, starting with 3.4)_ - set to "yes" to enable [the $facts hash and trusted node data](https://puppet.com/docs/puppet/3.8/lang_facts_and_builtin_vars.html#trusted-facts), which enabled ``$facts`` and ``$trusted`` hashes. This is equivalent to setting [trusted_node_data=true](https://puppet.com/docs/puppet/3.8/configuration.html#trustednodedata) - in puppet.conf. + in puppet.conf. * ``STRINGIFY_FACTS`` _(Puppet 3.x, starting with 3.5)_ - set to "no" to enable [structured facts](http://docs.puppetlabs.com/facter/2.0/fact_overview.html#writing-structured-facts), otherwise leave unset to retain the current default behavior. This is equivalent to setting [stringify_facts=false](https://puppet.com/docs/puppet/3.8/configuration.html#stringifyfacts) in puppet.conf. @@ -201,11 +201,11 @@ scm: hg ``` * `target` - the directory name to clone the repo into ie. `target: mymodule` defaults to the repo name (Optional) * `subdir` - directory to be removed from the cloned repo. Its contents will be moved to the root directory (Optional) - * `ref` - used to specify the tag name like version hash of commit (Optional) + * `ref` - used to specify the tag name (like version) or commit hash to be checked out (Optional). Branch names should use the `branch` option instead. ```yaml ref: 1.0.0 ref: 880fca52c ``` @@ -387,11 +387,11 @@ For example: to run tests marked ``tier_high => true`` and ``tier_medium => true`` in the same test run set the environment variable``TEST_TIERS=high,medium`` By default ``TEST_TIERS`` only accepts low, medium and high as valid tiers. If you would like to use your own keywords to set the environment variable ``TEST_TIERS_ALLOWED``. -For example: to use the keywords dev, rnd, staging and production you can set +For example: to use the keywords dev, rnd, staging and production you can set ``TEST_TIERS_ALLOWED=dev,rnd,staging,production``. Then you would be able to run tests marked ``tier_dev => true``, ``tier_production => true`` with ``TEST_TIERS=dev,production`` Note, if the ``TEST_TIERS`` environment variable is set to empty string or nil, all tiers will be executed. @@ -414,37 +414,10 @@ The reports can be generated every time you invoke RSpec, e.g. via `rake spec`, You can enable it, set the following environment variable:s ``SIMPLECOV=yes`` -Remember to add the simplecov-console and codecov gems to your `Gemfile`. - -Using Coveralls ---------------- - -You can also use [Coveralls](https://coveralls.io/) together with SimpleCov: - -```Ruby -# First line of spec/spec_helper.rb -require 'simplecov' -require 'coveralls' - -SimpleCov.formatters = [ - SimpleCov::Formatter::HTMLFormatter, - Coveralls::SimpleCov::Formatter -] - -SimpleCov.start do - add_filter '/spec/' - # Exclude bundled Gems in `/.vendor/` - add_filter '/.vendor/' -end - -require 'puppetlabs_spec_helper/module_spec_helper' -# Further content -``` - -Remember to add `gem 'coveralls', require: false` to your `Gemfile`. +Remember to add the simplecov-console and codecov gems to your `Gemfile`. If you run `spec:simplecov` on Travis-CI or any of the other supported CI services, reports gets automatically uploaded to https://codecov.io/ . Some Notes for Windows Users ============================ A windows users may need to do one of two things to execute `rake spec`.