Announce: Strings 0.99.0 Released!
Will Hopper
Hello, all! Today, we're pleased to announce the release of puppet-strings 0.99.0! Strings is a YARD-based documentation tool for Puppet extensions written in Puppet and Ruby. Given some simple in-code comments containing YARD tags, it will generate consistent HTML or JSON documentation for all of your Puppet 3x/4x API functions, Puppet language functions, Ruby classes, Ruby methods, types, and providers.
This release includes a near-complete rewrite of the project, fixing many bugs from previous versions and generally improving the user experience. Note that this release is intended to be the last stop before the strings major version 1.0.0 is released, and nearly all of the functionality of the major release is included.
Note also: backwards-incompatible changes have been made to the original JSON schema.
Highlights:
- Both HTML and JSON documentation has been split into sections based on type: Puppet 3x API functions, Puppet 4x API functions, Ruby classes/methods, Puppet language functions, types, and providers.
- New --emit-json and --emit-json-stdout command line options for generating JSON documentation.
- A brand new JSON schema organized around the new separation of types.
- Support for custom functions written in the puppet language.
- Support for function overloads via the create_function 4x API.
- YARD has been bumped to the latest version, greatly enhancing the look and usability of the HTML output.
Other important notes:
- Markdown is now the default format for parsing in-code docstrings.
- The runtime dependency of puppet has been removed in favor of a gem 'requirement' which appears on rubygems.org. This prevents conflicts when installing strings in older versions of Puppet Enterprise. We recommend you install the puppet-strings gem using puppet, as suggested in the README.
Never used Strings? Check out the README linked below and give it a try!
The CHANGELOG can be found here: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md
The ruby gem can be found here: https://rubygems.org/gems/puppet-strings
Installation and usage instructions can be found here: https://github.com/puppetlabs/puppet-strings/blob/master/README.md
To track issues related to this release or report issues, see the PDOC JIRA project:
- JIRA Project: https://tickets.puppetlabs.com/browse/PDOC
- Fixes for 0.99.0: https://tickets.puppetlabs.com/issues/?filter=22705
- Introduced in 0.99.0: https://tickets.puppetlabs.com/issues/?filter=22706