From ee8e08e4c98d260818ec26f3a9504b7d354f8e4d Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 5 Jul 2024 09:31:21 +0200 Subject: [PATCH] Document the rake task in the README - fixes #139 Signed-off-by: Robert Waffen --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fd7c34a..8010657 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ This is a helper Gem to test the various Vox Pupuli Puppet modules. This Gem provides common functionality for rspec-puppet based testing. The aim is to reduce the boiler plate and need for modulesync. -# Usage +## Usage + Add the `voxpupuli-test` Gem to your `Gemfile`: ```ruby @@ -35,7 +36,17 @@ inherit_gem: voxpupuli-test: rubocop.yml ``` -# Fact handling +## Rake tasks + +### `check:trailing_whitespace` + +The rake task `check:trailing_whitespace` checks for trailing whitespace in all markdown files in the repository. +It has an exclude pattern for: `%r{^((modules|acceptance|\.?vendor|spec/fixtures|pkg)/|REFERENCE.md)}` + +We recommend using the GitHub style guide for markdown files, which includes no trailing whitespace. +See [GitHub Markdown Style Guide](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) + +## Fact handling The recommended method is using [rspec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts) and is set up by default. This means the tests are writting as follows: