Merge pull request #109 from whopper/PDOC-108/version_changelog_bump
(PDOC-108) Update CHANGELOG and gemspec for 0.99.0 release
This commit is contained in:
commit
eeb5479af4
26
CHANGELOG.md
26
CHANGELOG.md
|
@ -1,3 +1,29 @@
|
|||
##2016-10-10 - Release 0.99.0
|
||||
|
||||
###Summary
|
||||
|
||||
This release includes a complete rewrite of strings, fixing many bugs from previous versions and generally improving the user experience. This release is intended to be the last stop before the strings major version 1.0 is released, and nearly all of the functionality of the major release is included.
|
||||
|
||||
###Features
|
||||
- Complete overhaul, including code cleanup, bug fixes and new functionality **(PDOC-63)**
|
||||
- Documentation has been split into sections based on type: puppet 3x API functions, puppet 4x API functions, ruby classes, puppet language functions, types, and providers
|
||||
- New JSON schema organized to reflect the separation of types
|
||||
- Support for custom functions written in the puppet language
|
||||
- Support for puppet function overloads via the create_function 4.x API
|
||||
- YARD bumped to latest version, 0.9.5
|
||||
- Markdown is now the default format for parsing docstring text **(PDOC-86)**
|
||||
- Note: this means Markdown text in YARD comments and tags, not a change in the output of strings
|
||||
- New commandline options: --emit-json and --emit-json-stdout to generate JSON documentation **(PDOC-84)**
|
||||
- Runtime dependency on Puppet has been removed, allowing strings to function in Puppet Enterprise 3.8 **(PDOC-80)**
|
||||
- Note that the gem still requires puppet. We recommend that the strings gem be installed with puppet, as suggested in the [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#installing-puppet-strings)
|
||||
- New gemspec requirement on Ruby version 1.9.3, the oldest supported Ruby version
|
||||
|
||||
###BugFixes
|
||||
|
||||
- Prevents a blizzard of errors when documenting Puppet Core source and some puppet modules **(PDOC-63)**
|
||||
- As this is a complete rewrite, many known and unknown bugs from the original code were fixed along the way
|
||||
- Allow strings to be installed in PE 3.8 without overwriting existing puppet and facter installations with newer gems
|
||||
|
||||
##2016-03-30 - Release 0.4.0
|
||||
|
||||
###Summary
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
Gem::Specification.new do |s|
|
||||
s.name = 'puppet-strings'
|
||||
s.author = 'Puppet Inc.'
|
||||
s.version = '0.4.0'
|
||||
s.version = '0.99.0'
|
||||
s.license = 'Apache-2.0'
|
||||
s.summary = 'Puppet documentation via YARD'
|
||||
s.email = 'info@puppet.com'
|
||||
|
|
Loading…
Reference in New Issue