Skip to content

Commit 21fe3f2

Browse files
authored
Merge pull request #75 from puppetlabs/CAT-1224-Update_README
(CAT-1224) - Bring README up-to-date
2 parents 5122a70 + 3cf3800 commit 21fe3f2

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
* [Installation](#installation)
1010
* [Starting out with a new module](#starting-out-with-a-new-module)
11-
* [Configure manifests for Puppet 4](#configure-manifests-for-puppet-4)
1211
* [Configuration](#configuration)
1312
* [Naming conventions](#naming-conventions)
1413
* [Example groups](#example-groups)
@@ -997,23 +996,26 @@ end
997996
```
998997

999998
Resources declared outside of the module being tested (i.e. forge dependencies)
1000-
are automatically removed from the coverage report. There is one exception for
1001-
this though: **prior to Puppet 4.6.0**, resources created by functions
1002-
(create\_resources(), ensure\_package(), etc) did not have the required
1003-
information in them to determine which manifest they came from and so can not
1004-
be excluded from the coverage report.
999+
are automatically removed from the coverage report.
10051000

10061001
## Related projects
10071002

10081003
* [puppetlabs_spec_helper](https://github.com/puppetlabs/puppetlabs_spec_helper): shared spec helpers to setup puppet
1009-
* [rspec-puppet-augeas](https://github.com/domcleal/rspec-puppet-augeas): RSpec tests for Augeas resources inside Puppet manifests
1010-
* [jimdo-rspec-puppet-helpers](https://github.com/Jimdo/jimdo-rspec-puppet-helpers): Tests the contents of a file with a source
1011-
* Ease development of specs
1012-
* [puppet-catalog_rspec](https://github.com/enterprisemodules/puppet-catalog_rspec): Dump the Puppet Catalog as RSpec code at compile time
1013-
* [create_specs](https://github.com/alexharv074/create_specs.git): A different implementation that takes a compiled catalog and writes out RSpec code with various options
10141004
* Fact providers
1015-
* [rspec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts): Simplify your unit tests by looping on every supported Operating System and populating facts.
1016-
* [rspec-puppet-osmash](https://github.com/Aethylred/rspec-puppet-osmash): Provides Operation System hashes and validations for rspec-puppet
1017-
* [puppet_spec_facts](https://github.com/danieldreier/puppet_spec_facts): Gem to provide puppet fact hashes for rspec-puppet testing
1005+
* [rspec-puppet-facts](https://github.com/voxpupuli/rspec-puppet-facts): Simplify your unit tests by looping on every supported Operating System and populating facts.
10181006

10191007
For a list of other module development tools see [DevX Tools](https://puppetlabs.github.io/content-and-tooling-team/tools/), or from our trusted Voxpupuli community [here](https://voxpupuli.org/plugins/).
1008+
1009+
## Reporting bugs or incorrect results
1010+
1011+
If you find a bug in Puppet Lint or its results, please create an issue in the repo issues tracker. Bonus points will be awarded if you also include a patch that fixes the issue.
1012+
1013+
## Development
1014+
1015+
If you run into an issue with this tool or would like to request a feature you can raise a PR with your suggested changes. Alternatively, you can raise a Github issue with a feature request or to report any bugs. Every other Tuesday the DevX team holds office hours in the Puppet Community Slack, where you can ask questions about this and any other supported tools. This session runs at 15:00 (GMT/BST) for about an hour.
1016+
1017+
If you have problems getting this tool up and running, please contact Support.
1018+
1019+
## Thank you
1020+
1021+
Many thanks to the original author of rspec-puppet Tim Sharpe (@rodjek).

0 commit comments

Comments
 (0)