release prep and gcg config

CHANGELOG.md

@@ -1,3 +1,21 @@
+# Change log
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
+
+## [1.2.0](https://github.com/puppetlabs/puppet-strings/tree/1.2.0) (2018-02-26)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.1.1...1.2.0)
+
+### Added
+
+- \(PDOC-184\) generate markdown [\#156](https://github.com/puppetlabs/puppet-strings/pull/156) ([eputnam](https://github.com/eputnam))
+- \(PDK-437\) Add support for Resource API types [\#153](https://github.com/puppetlabs/puppet-strings/pull/153) ([DavidS](https://github.com/DavidS))
+
+### Fixed
+
+- Fix return type matching for Puppet functions [\#159](https://github.com/puppetlabs/puppet-strings/pull/159) ([pegasd](https://github.com/pegasd))
+- Add rgen as a runtime dependency [\#149](https://github.com/puppetlabs/puppet-strings/pull/149) ([rnelson0](https://github.com/rnelson0))
+
 ## 2017-10-20 - Release 1.1.1
 
 ### BugFixes
@@ -166,3 +184,6 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
 - Puppet namespaces are no longer mangled for nested classes and defined types **(PDOC-25)**
 - Strings is now compatible with the renaming of the Puppetx/puppetx namespace to PuppetX/puppet_x **(PDOC-26)**
 - Strings will no longer crash when documenting 3x functions with less than two arguments passed into newfunction **(PDOC-27)**
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

Gemfile

@@ -5,6 +5,7 @@ gemspec
 gem 'rgen'
 gem 'redcarpet'
 gem 'yard', '~> 0.9.11'
+gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator', ref: 'master'
 
 if ENV['PUPPET_GEM_VERSION']
   gem 'puppet', ENV['PUPPET_GEM_VERSION'], :require => false

README.md

@@ -463,6 +463,7 @@ function example(string $name) {
 
 ### Available Strings tags
 
+* `@api`: Describes the resource as private or public, most commonly used with classes or defined types.
 * `@example`: Shows an example snippet of code for an object. The first line is an optional title. See above for more about how to [include examples in documentation](#including-examples-in-documentation).
 * `@param`: Documents a parameter with a given name, type and optional description.
 * `@!puppet.type.param`: Documents dynamic type parameters. See [Documenting resource types and providers](#documenting-resource-types-and-providers) above.

Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-lint/tasks/puppet-lint'
+require 'github_changelog_generator/task'
 
 # Add our own tasks
 require 'puppet-strings/tasks'
@@ -8,6 +9,32 @@ require 'puppet-strings/tasks'
 PuppetLint.configuration.send('disable_80chars')
 PuppetLint.configuration.ignore_paths = %w(acceptance/**/*.pp spec/**/*.pp pkg/**/*.pp)
 
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'puppetlabs'
+  config.project = 'puppet-strings'
+  config.since_tag = '1.1.1'
+  config.future_release = '1.2.0'
+  config.exclude_labels = ['maintenance']
+  config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)."
+  config.add_pr_wo_labels = true
+  config.issues = false
+  config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM"
+  config.configure_sections = {
+    "Changed" => {
+      "prefix" => "### Changed",
+      "labels" => ["backwards-incompatible"],
+    },
+    "Added" => {
+      "prefix" => "### Added",
+      "labels" => ["feature", "enhancement"],
+    },
+    "Fixed" => {
+      "prefix" => "### Fixed",
+      "labels" => ["bugfix"],
+    },
+  }
+end
+
 desc 'Validate Ruby source files and ERB templates.'
 task :validate do
   Dir['spec/**/*.rb','lib/**/*.rb'].each do |ruby_file|

puppet-strings.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-strings'
   s.author = 'Puppet Inc.'
-  s.version = '1.1.1'
+  s.version = '1.2.0'
   s.license = 'Apache-2.0'
   s.summary = 'Puppet documentation via YARD'
   s.email = 'info@puppet.com'