Merge pull request #7 from ploperations/release-prep

2.0.0 release prep

Author: genebean

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
           documentation=$(pdk bundle exec puppet strings generate --format markdown)
           if [ $(echo $documentation | grep -Ec "[1-9]+ undocumented|\[warn\]") -gt 0 ]; then
             echo "Please resolve documentation issues detected below:"
-            echo $documentation
+            echo "$documentation"
             exit 1
           fi
           if output=$(git status --porcelain) && [ ! -z "$output" ]; then

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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).
 
+## [2.0.0](https://github.com/ploperations/ploperations-ssl/tree/2.0.0) (2021-09-18)
+
+[Full Changelog](https://github.com/ploperations/ploperations-ssl/compare/1.0.0...2.0.0)
+
+### Changed
+
+- Dropped old Puppet versions, added new ones, sync to current standards [\#6](https://github.com/ploperations/ploperations-ssl/pull/6) ([genebean](https://github.com/genebean))
+
 ## [1.0.0](https://github.com/ploperations/ploperations-ssl/tree/1.0.0) (2020-03-02)
 
 [Full Changelog](https://github.com/ploperations/ploperations-ssl/compare/132268db8eee957e11a9ac079f76386491065fd1...1.0.0)

REFERENCE.md

@@ -1,28 +1,29 @@
 # Reference
+
 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
 
 ## Table of Contents
 
-**Classes**
+### Classes
 
 * [`ssl`](#ssl): Maintain SSL certs and private keys
 * [`ssl::params`](#sslparams): Determine default parameters for ssl
 
-**Defined types**
+### Defined types
 
 * [`ssl::cert`](#sslcert): Deploy SSL certificates and keys in a couple of common formats
 * [`ssl::cert::haproxy`](#sslcerthaproxy): Install key and certs combination for HAProxy
 * [`ssl::cert::nginx`](#sslcertnginx): DEPRECATED
 * [`ssl::hashfile`](#sslhashfile): Create certificate hash file
 
-**Functions**
+### Functions
 
 * [`ssl::ensure_newline`](#sslensure_newline): Ensure there's a trailing newline
 * [`ssl::pem::join`](#sslpemjoin): Join certs and keys into a single PEM. Ensure the correct newlines exist.
 
 ## Classes
 
-### ssl
+### <a name="ssl"></a>`ssl`
 
 You can store SSL certs in your control repo. Simply create a profile and put
 the certs in its files directory. (Note that you don't actually have to create
@@ -44,37 +45,41 @@ ssl::keys:
 
 #### Parameters
 
-The following parameters are available in the `ssl` class.
+The following parameters are available in the `ssl` class:
+
+* [`cert_source`](#cert_source)
+* [`keys`](#keys)
+* [`manage_ssl_dir`](#manage_ssl_dir)
 
-##### `cert_source`
+##### <a name="cert_source"></a>`cert_source`
 
 Data type: `String[1]`
 
 Where to find cert files with the file() function.
 
-##### `keys`
+##### <a name="keys"></a>`keys`
 
 Data type: `Hash[String[1], String[1]]`
 
 Private keys indexed by key names.
 
-Default value: {}
+Default value: `{}`
 
-##### `manage_ssl_dir`
+##### <a name="manage_ssl_dir"></a>`manage_ssl_dir`
 
 Data type: `Boolean`
 
 Enable or disable a file resource for the ssl directory
 
-Default value: `true`
+Default value: ``true``
 
-### ssl::params
+### <a name="sslparams"></a>`ssl::params`
 
 Determine default parameters for ssl
 
 ## Defined types
 
-### ssl::cert
+### <a name="sslcert"></a>`ssl::cert`
 
 Deploy SSL certificates and keys in a couple of common formats
 
@@ -99,59 +104,66 @@ ssl::cert { 'www.example.com': }
 
 #### Parameters
 
-The following parameters are available in the `ssl::cert` defined type.
+The following parameters are available in the `ssl::cert` defined type:
+
+* [`key_name`](#key_name)
+* [`cert_dir`](#cert_dir)
+* [`key_dir`](#key_dir)
+* [`user`](#user)
+* [`group`](#group)
+* [`mode`](#mode)
 
-##### `key_name`
+##### <a name="key_name"></a>`key_name`
 
 Data type: `String[1]`
 
 The name of the certificate
 
-Default value: $title
+Default value: `$title`
 
-##### `cert_dir`
+##### <a name="cert_dir"></a>`cert_dir`
 
 Data type: `Optional[String[1]]`
 
 The directory that certs are stored in. If no values is provided then the
 value from $ssl::cert_dir is used.
 
-Default value: `undef`
+Default value: ``undef``
 
-##### `key_dir`
+##### <a name="key_dir"></a>`key_dir`
 
 Data type: `Optional[String[1]]`
 
 The directory that certificate keys are stored in. If no values is provided
 then the value from $ssl::key_dir is used.
 
-Default value: `undef`
+Default value: ``undef``
 
-##### `user`
+##### <a name="user"></a>`user`
 
 Data type: `String[1]`
 
 The user to set as the owner of the generated files
 
-Default value: 'root'
+Default value: `'root'`
 
-##### `group`
+##### <a name="group"></a>`group`
 
 Data type: `String[1]`
 
 THe group to set as the owner of the generated files
 
-Default value: '0'
+Default value: `'0'`
 
-##### `mode`
+##### <a name="mode"></a>`mode`
 
 Data type: `String[1]`
 
 The file mode to be set on each generated file
 
-Default value: '0640'
+Default value: `'0640'`
 
-### ssl::cert::haproxy
+### <a name="sslcerthaproxy"></a>`ssl::cert::haproxy`
 
 Install key and certs combination for HAProxy.
 
@@ -182,49 +194,55 @@ ssl::cert::haproxy { 'www.example.com':
 
 #### Parameters
 
-The following parameters are available in the `ssl::cert::haproxy` defined type.
+The following parameters are available in the `ssl::cert::haproxy` defined type:
 
-##### `key_name`
+* [`key_name`](#key_name)
+* [`path`](#path)
+* [`user`](#user)
+* [`group`](#group)
+* [`mode`](#mode)
+
+##### <a name="key_name"></a>`key_name`
 
 Data type: `String[1]`
 
 The name of the certificate
 
-Default value: $title
+Default value: `$title`
 
-##### `path`
+##### <a name="path"></a>`path`
 
 Data type: `Stdlib::Unixpath`
 
 The full path of the certificate, including the certificate's name.
 
-Default value: "/etc/haproxy/certs.d/${key_name}.crt"
+Default value: `"/etc/haproxy/certs.d/${key_name}.crt"`
 
-##### `user`
+##### <a name="user"></a>`user`
 
 Data type: `String[1]`
 
 The user that owns the certificate
 
-Default value: 'root'
+Default value: `'root'`
 
-##### `group`
+##### <a name="group"></a>`group`
 
 Data type: `String[1]`
 
 The group that owns the certificate
 
-Default value: '0'
+Default value: `'0'`
 
-##### `mode`
+##### <a name="mode"></a>`mode`
 
 Data type: `String[1]`
 
 The file mode of the certificate file
 
-Default value: '0400'
+Default value: `'0400'`
 
-### ssl::cert::nginx
+### <a name="sslcertnginx"></a>`ssl::cert::nginx`
 
 This is only here to simplify some of our legacy code.
 
@@ -233,59 +251,66 @@ We recommend using `ssl::cert` and configuring NGINX to use the
 
 #### Parameters
 
-The following parameters are available in the `ssl::cert::nginx` defined type.
+The following parameters are available in the `ssl::cert::nginx` defined type:
+
+* [`key_name`](#key_name)
+* [`cert_dir`](#cert_dir)
+* [`key_dir`](#key_dir)
+* [`user`](#user)
+* [`group`](#group)
+* [`mode`](#mode)
 
-##### `key_name`
+##### <a name="key_name"></a>`key_name`
 
 Data type: `String[1]`
 
 The name of the certificate
 
-Default value: $title
+Default value: `$title`
 
-##### `cert_dir`
+##### <a name="cert_dir"></a>`cert_dir`
 
 Data type: `Optional[String[1]]`
 
 The directory that certs are stored in. If no values is provided then the
 value from $ssl::cert_dir is used.
 
-Default value: `undef`
+Default value: ``undef``
 
-##### `key_dir`
+##### <a name="key_dir"></a>`key_dir`
 
 Data type: `Optional[String[1]]`
 
 The directory that certificate keys are stored in. If no values is provided
 then the value from $ssl::key_dir is used.
 
-Default value: `undef`
+Default value: ``undef``
 
-##### `user`
+##### <a name="user"></a>`user`
 
 Data type: `String[1]`
 
 The user to set as the owner of the generated files
 
-Default value: 'root'
+Default value: `'root'`
 
-##### `group`
+##### <a name="group"></a>`group`
 
 Data type: `String[1]`
 
 THe group to set as the owner of the generated files
 
-Default value: '0'
+Default value: `'0'`
 
-##### `mode`
+##### <a name="mode"></a>`mode`
 
 Data type: `String[1]`
 
 The file mode to be set on each generated file
 
-Default value: '0640'
+Default value: `'0640'`
 
-### ssl::hashfile
+### <a name="sslhashfile"></a>`ssl::hashfile`
 
 Create certificate hash file
 
@@ -301,17 +326,19 @@ Create certificate hash file
 
 #### Parameters
 
-The following parameters are available in the `ssl::hashfile` defined type.
+The following parameters are available in the `ssl::hashfile` defined type:
+
+* [`certdir`](#certdir)
 
-##### `certdir`
+##### <a name="certdir"></a>`certdir`
 
 Data type: `Stdlib::Unixpath`
 
 The directory ssl certs are stored in
 
 ## Functions
 
-### ssl::ensure_newline
+### <a name="sslensure_newline"></a>`ssl::ensure_newline`
 
 Type: Puppet Language
 
@@ -351,7 +378,7 @@ Data type: `String[0]`
 
 A string to ensure ends with a new line (aka '\n')
 
-### ssl::pem::join
+### <a name="sslpemjoin"></a>`ssl::pem::join`
 
 Type: Puppet Language
 

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "ploperations-ssl",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "author": "ploperations",
   "summary": "Manage SSL certificates and keys",
   "license": "Apache-2.0",