Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2025-01-12 05:09:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
inspec/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/README.md
Clinton Wolfe 5343c217b0 All templates work, but need to decide on hooks 
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 11:58:10 -05:00

881 B
Raw Blame History

<%= module_name %> Plugin

This plugin was generated by inspec init plugin, and apparently the author, '<%= author_name %>', did not update the README.

To Install This Plugin

Assuming it has been published to RubyGems, you can install this gem using:

you@machine $ inspec plugin install <%= plugin_name %>

What This Plugin Does

No idea.

Developing This Plugin

The generated plugin contains everything a real-world, industrial grade plugin would have, including:

  • an (possibly incomplete) implementation of one or more InSpec Plugin Types
  • documentation (you are reading it now)
  • tests, at the unit and functional level
  • a .gemspec, for packaging and publishing it as a gem
  • a Gemfile, for managing its dependencies
  • a Rakefile, for running development tasks
  • Rubocop linting support for using the base InSpec project rubocop.yml (See Rakefile)