Skip to content

Commit 6e981df

Browse files
committed
Update README.md and add badges
1 parent 6872102 commit 6e981df

File tree

1 file changed

+39
-16
lines changed

1 file changed

+39
-16
lines changed

README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
Installation
2-
===
1+
# Installation
32

4-
[![Build Status](https://travis-ci.org/relud/puppet-lint-strict_indent-check.svg?branch=master)](https://travis-ci.org/relud/puppet-lint-strict_indent-check)
3+
[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-strict_indent-check.svg)](https://github.com/voxpupuli/puppet-lint-strict_indent-check/blob/master/LICENSE)
4+
[![Test](https://github.com/voxpupuli/puppet-lint-strict_indent-check/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-strict_indent-check/actions/workflows/test.yml)
5+
[![codecov](https://codecov.io/gh/voxpupuli/puppet-lint-strict_indent-check/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/puppet-lint-strict_indent-check)
6+
[![Release](https://github.com/voxpupuli/puppet-lint-strict_indent-check/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-strict_indent-check/actions/workflows/release.yml)
7+
[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-strict_indent-check.svg)](https://rubygems.org/gems/puppet-lint-strict_indent-check)
8+
[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-strict_indent-check.svg)](https://rubygems.org/gems/puppet-lint-strict_indent-check)
9+
[![Donated by Daniel Thorn](https://img.shields.io/badge/donated%20by-Daniel%20Thorn-fb7047.svg)](#transfer-notice)
510

6-
<pre>
7-
gem install puppet-lint-strict_indent-check
8-
</pre>
11+
A puppet-lint plugin to validate Puppet DSL indentation
912

10-
Usage
11-
===
13+
## Usage
1214

1315
This plugin provides an indentation check for puppet-lint `strict_indent`. The check has a strict expectation for all indentation, except comments and whitespace/blank lines.
1416

1517
supports --fix flag
1618

1719
Check will raise a warning for any files that don't have 2-space indent, and follow specific guidelines for increase/decrease of indent.
1820

19-
Alternate Indentation
20-
===
21+
## Alternate Indentation
2122

2223
Indentation defaults to 2 spaces. To use a different number of spaces, use the `-l` option to load ruby file changing the `chars_per_indent` config.
2324

2425
config file `chars_per_indent_4.rb`:
25-
<pre>
26+
```
2627
# This could also be set in your Rakefile
2728
PuppetLint.configuration.chars_per_indent = 4
28-
</pre>
29+
```
2930

3031
lint command:
31-
<pre>
32+
```
3233
puppet-lint -l chars_per_indent_4.rb puppet-mysql/manifests/init.pp
33-
</pre>
34+
```
3435

35-
Acceptable Identation
36-
===
36+
## Acceptable Identation
3737

3838
* indent should increase by one step the line after each opened brace (square, curly, paren)
3939
* indent should decrease by one step the line of every closed brace.
@@ -45,3 +45,26 @@ Acceptable Identation
4545
see `spec/fixtures/pass/` for good indentation examples.
4646

4747
see `spec/fixtures/fail/` for bad indentation examples.
48+
49+
## Transfer Notice
50+
51+
This plugin was originally authored by [Daniel Thorn](https://github.com/relud).
52+
The maintainer preferred that Vox Pupuli take ownership of the module for future improvement and maintenance.
53+
Existing pull requests and issues were transferred over, please fork and continue to contribute at https://github.com/voxpupuli/puppet-lint-strict_indent-check.
54+
55+
Previously: https://github.com/relud/puppet-lint-strict_indent-check
56+
57+
## License
58+
59+
This gem is licensed under the Mozilla Public license 2.
60+
61+
62+
## Release information
63+
64+
To make a new release, please do:
65+
* update the version in the gemspec file
66+
* Install gems with `bundle install --with release --path .vendor`
67+
* generate the changelog with `bundle exec rake changelog`
68+
* Check if the new version matches the closed issues/PRs in the changelog
69+
* Create a PR with it
70+
* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

0 commit comments

Comments
 (0)