From fba4df7c5d4b16c6c01647d7834da273c352ae70 Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Thu, 6 Apr 2023 14:58:48 +0100 Subject: [PATCH] (maint) - Release prep v5.4.1 --- CHANGELOG.md | 13 ++++- REFERENCE.md | 144 +++++++++++++++++++++++++------------------------- metadata.json | 2 +- 3 files changed, 84 insertions(+), 75 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 63cbdb92..1f3339f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,15 @@ 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). +## [v5.4.1](https://github.com/puppetlabs/puppetlabs-inifile/tree/v5.4.1) (2023-04-06) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/compare/v5.4.0...v5.4.1) + +### Fixed + +- pdksync - \(CONT-189\) Remove support for RedHat6 / OracleLinux6 / Scientific6 [\#492](https://github.com/puppetlabs/puppetlabs-inifile/pull/492) ([david22swan](https://github.com/david22swan)) +- pdksync - \(CONT-130\) - Dropping Support for Debian 9 [\#489](https://github.com/puppetlabs/puppetlabs-inifile/pull/489) ([jordanbreen28](https://github.com/jordanbreen28)) + ## [v5.4.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v5.4.0) (2022-10-03) [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/compare/v5.3.0...v5.4.0) @@ -101,7 +110,7 @@ All notable changes to this project will be documented in this file. The format ### Added -- Finish API conversion of `create_ini_settings` [\#387](https://github.com/puppetlabs/puppetlabs-inifile/pull/387) ([alexjfisher](https://github.com/alexjfisher)) +- Finish API conversion of `create\_ini\_settings` [\#387](https://github.com/puppetlabs/puppetlabs-inifile/pull/387) ([alexjfisher](https://github.com/alexjfisher)) ## [v4.1.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v4.1.0) (2020-01-15) @@ -147,6 +156,7 @@ All notable changes to this project will be documented in this file. The format ### Fixed - FM-7779 - Cleanup Inifile [\#328](https://github.com/puppetlabs/puppetlabs-inifile/pull/328) ([lionce](https://github.com/lionce)) +- \(MODULES-6714\) - inifile: ensure absent not working with refreshonly = true [\#313](https://github.com/puppetlabs/puppetlabs-inifile/pull/313) ([Lavinia-Dan](https://github.com/Lavinia-Dan)) ## [2.5.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/2.5.0) (2018-12-28) @@ -160,7 +170,6 @@ All notable changes to this project will be documented in this file. The format ### Fixed - pdksync - \(FM-7655\) Fix rubygems-update for ruby \< 2.3 [\#320](https://github.com/puppetlabs/puppetlabs-inifile/pull/320) ([tphoney](https://github.com/tphoney)) -- \(MODULES-6714\) - inifile: ensure absent not working with refreshonly = true [\#313](https://github.com/puppetlabs/puppetlabs-inifile/pull/313) ([Lavinia-Dan](https://github.com/Lavinia-Dan)) - \(FM-7483\) - update module to the latest version [\#310](https://github.com/puppetlabs/puppetlabs-inifile/pull/310) ([lionce](https://github.com/lionce)) - \(FM-7331\)-Fix japanese test [\#308](https://github.com/puppetlabs/puppetlabs-inifile/pull/308) ([lionce](https://github.com/lionce)) diff --git a/REFERENCE.md b/REFERENCE.md index 00d5d93e..47595645 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -12,7 +12,7 @@ ### Functions * [`create_ini_settings`](#create_ini_settings): DEPRECATED. Use the namespaced function [`inifile::create_ini_settings`](#inifilecreate_ini_settings) instead. -* [`inifile::create_ini_settings`](#inifilecreate_ini_settings): This function is used to create a set of ini_setting resources from a hash +* [`inifile::create_ini_settings`](#inifile--create_ini_settings): This function is used to create a set of ini_setting resources from a hash ## Resource types @@ -40,96 +40,96 @@ The value of the setting to be defined. The following parameters are available in the `ini_setting` type. -* [`force_new_section_creation`](#force_new_section_creation) -* [`indent_char`](#indent_char) -* [`indent_width`](#indent_width) -* [`key_val_separator`](#key_val_separator) -* [`name`](#name) -* [`path`](#path) -* [`provider`](#provider) -* [`refreshonly`](#refreshonly) -* [`section`](#section) -* [`section_prefix`](#section_prefix) -* [`section_suffix`](#section_suffix) -* [`setting`](#setting) -* [`show_diff`](#show_diff) +* [`force_new_section_creation`](#-ini_setting--force_new_section_creation) +* [`indent_char`](#-ini_setting--indent_char) +* [`indent_width`](#-ini_setting--indent_width) +* [`key_val_separator`](#-ini_setting--key_val_separator) +* [`name`](#-ini_setting--name) +* [`path`](#-ini_setting--path) +* [`provider`](#-ini_setting--provider) +* [`refreshonly`](#-ini_setting--refreshonly) +* [`section`](#-ini_setting--section) +* [`section_prefix`](#-ini_setting--section_prefix) +* [`section_suffix`](#-ini_setting--section_suffix) +* [`setting`](#-ini_setting--setting) +* [`show_diff`](#-ini_setting--show_diff) -##### `force_new_section_creation` +##### `force_new_section_creation` -Valid values: ``true``, ``false``, `yes`, `no` +Valid values: `true`, `false`, `yes`, `no` Create setting only if the section exists -Default value: ``true`` +Default value: `true` -##### `indent_char` +##### `indent_char` The character to indent new settings with. Default value: ` ` -##### `indent_width` +##### `indent_width` The number of indent_chars to use to indent a new setting. -##### `key_val_separator` +##### `key_val_separator` The separator string to use between each setting name and value. Default value: ` = ` -##### `name` +##### `name` namevar An arbitrary name used as the identity of the resource. -##### `path` +##### `path` The ini file Puppet will ensure contains the specified setting. -##### `provider` +##### `provider` The specific backend to use for this `ini_setting` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `refreshonly` +##### `refreshonly` -Valid values: ``true``, ``false``, `yes`, `no` +Valid values: `true`, `false`, `yes`, `no` A flag indicating whether or not the ini_setting should be updated only when called as part of a refresh event -Default value: ``false`` +Default value: `false` -##### `section` +##### `section` The name of the section in the ini file in which the setting should be defined. Default value: `''` -##### `section_prefix` +##### `section_prefix` The prefix to the section name\'s header. Default value: `[` -##### `section_suffix` +##### `section_suffix` The suffix to the section name\'s header. Default value: `]` -##### `setting` +##### `setting` The name of the setting to be defined. -##### `show_diff` +##### `show_diff` -Valid values: ``true``, `md5`, ``false`` +Valid values: `true`, `md5`, `false` Whether to display differences when the setting changes. -Default value: ``true`` +Default value: `true` ### `ini_subsetting` @@ -155,31 +155,31 @@ The value of the subsetting to be defined. The following parameters are available in the `ini_subsetting` type. -* [`delete_if_empty`](#delete_if_empty) -* [`insert_type`](#insert_type) -* [`insert_value`](#insert_value) -* [`key_val_separator`](#key_val_separator) -* [`name`](#name) -* [`path`](#path) -* [`provider`](#provider) -* [`quote_char`](#quote_char) -* [`section`](#section) -* [`setting`](#setting) -* [`show_diff`](#show_diff) -* [`subsetting`](#subsetting) -* [`subsetting_key_val_separator`](#subsetting_key_val_separator) -* [`subsetting_separator`](#subsetting_separator) -* [`use_exact_match`](#use_exact_match) - -##### `delete_if_empty` - -Valid values: ``true``, ``false`` +* [`delete_if_empty`](#-ini_subsetting--delete_if_empty) +* [`insert_type`](#-ini_subsetting--insert_type) +* [`insert_value`](#-ini_subsetting--insert_value) +* [`key_val_separator`](#-ini_subsetting--key_val_separator) +* [`name`](#-ini_subsetting--name) +* [`path`](#-ini_subsetting--path) +* [`provider`](#-ini_subsetting--provider) +* [`quote_char`](#-ini_subsetting--quote_char) +* [`section`](#-ini_subsetting--section) +* [`setting`](#-ini_subsetting--setting) +* [`show_diff`](#-ini_subsetting--show_diff) +* [`subsetting`](#-ini_subsetting--subsetting) +* [`subsetting_key_val_separator`](#-ini_subsetting--subsetting_key_val_separator) +* [`subsetting_separator`](#-ini_subsetting--subsetting_separator) +* [`use_exact_match`](#-ini_subsetting--use_exact_match) + +##### `delete_if_empty` + +Valid values: `true`, `false` Set to true to delete the parent setting when the subsetting is empty instead of writing an empty string -Default value: ``false`` +Default value: `false` -##### `insert_type` +##### `insert_type` Valid values: `start`, `end`, `before`, `after`, `index` @@ -193,79 +193,79 @@ Where the new subsetting item should be inserted Default value: `end` -##### `insert_value` +##### `insert_value` The value for the insert types which require one. -##### `key_val_separator` +##### `key_val_separator` The separator string to use between each setting name and value. Default value: ` = ` -##### `name` +##### `name` namevar An arbitrary name used as the identity of the resource. -##### `path` +##### `path` The ini file Puppet will ensure contains the specified setting. -##### `provider` +##### `provider` The specific backend to use for this `ini_subsetting` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `quote_char` +##### `quote_char` The character used to quote the entire value of the setting. Valid values are '', '\"' and \"'\" Default value: `''` -##### `section` +##### `section` The name of the section in the ini file in which the setting should be defined. Default value: `''` -##### `setting` +##### `setting` The name of the setting to be defined. -##### `show_diff` +##### `show_diff` -Valid values: ``true``, `md5`, ``false`` +Valid values: `true`, `md5`, `false` Whether to display differences when the setting changes. -Default value: ``true`` +Default value: `true` -##### `subsetting` +##### `subsetting` The name of the subsetting to be defined. -##### `subsetting_key_val_separator` +##### `subsetting_key_val_separator` The separator string between the subsetting name and its value. Defaults to the empty string. Default value: `''` -##### `subsetting_separator` +##### `subsetting_separator` The separator string between subsettings. Defaults to the empty string. Default value: ` ` -##### `use_exact_match` +##### `use_exact_match` -Valid values: ``true``, ``false`` +Valid values: `true`, `false` Set to true if your subsettings don\'t have values and you want to use exact matches to determine if the subsetting exists. -Default value: ``false`` +Default value: `false` ## Functions @@ -287,7 +287,7 @@ Data type: `Any` -### `inifile::create_ini_settings` +### `inifile::create_ini_settings` Type: Ruby 4.x API diff --git a/metadata.json b/metadata.json index cd9bbfa7..ce0b268e 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-inifile", - "version": "5.4.0", + "version": "5.4.1", "author": "puppetlabs", "summary": "Resource types for managing settings in INI files", "license": "Apache-2.0",