Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the trailing_whitespace rake task in the README #142

Merged
merged 1 commit into from
Jul 5, 2024
Merged

Document the trailing_whitespace rake task in the README #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:

Expand Down
Loading