https://github.com/dodevops/puppet-lint-summary_comment-check

A Puppet lint plugin to check a valid summary comment
https://github.com/dodevops/puppet-lint-summary_comment-check

Last synced: 2 months ago
JSON representation

A Puppet lint plugin to check a valid summary comment

• Host: GitHub
• URL: https://github.com/dodevops/puppet-lint-summary_comment-check
• Owner: dodevops
• License: mit
• Created: 2022-05-24T11:29:01.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-05-24T11:49:14.000Z (about 4 years ago)
• Last Synced: 2025-12-18T12:16:32.773Z (6 months ago)
• Language: Ruby
• Homepage: https://rubygems.org/gems/puppet-lint-summary_comment-check
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Puppet lint summary check

This checks whether a class contains a valid header comment that starts with a summary like this:

```

# @summary

#   This is a Puppet class

class my_class {

```

## Usage

To use the plugin, add the following line to the Gemfile:

    gem 'puppet-lint-summary_comment-check'