diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bc92b2..0634fdb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,48 +1,55 @@ -# Changelog +# 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). + +## [v1.0.0](https://github.com/puppetlabs/puppetlabs-transition/tree/v1.0.0) (2022-02-28) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-transition/compare/0.1.3...v1.0.0) + +### Changed + +- \(SUP-2799\) Update to Supportable OS and Puppet Versions [\#23](https://github.com/puppetlabs/puppetlabs-transition/pull/23) ([MartyEwings](https://github.com/MartyEwings)) + +### Added + +- \(SUP-2798\) \(MODULES-11208\) PDK Update and Puppet 7 Inclusion [\#18](https://github.com/puppetlabs/puppetlabs-transition/pull/18) ([MartyEwings](https://github.com/MartyEwings)) ## [0.1.3](https://github.com/puppetlabs/puppetlabs-transition/tree/0.1.3) (2020-02-25) [Full Changelog](https://github.com/puppetlabs/puppetlabs-transition/compare/0.1.2...0.1.3) -**Merged pull requests:** +### Added - Correct an error with \#10 [\#15](https://github.com/puppetlabs/puppetlabs-transition/pull/15) ([binford2k](https://github.com/binford2k)) -- \(maint\) Convert to PDK [\#14](https://github.com/puppetlabs/puppetlabs-transition/pull/14) ([binford2k](https://github.com/binford2k)) ## [0.1.2](https://github.com/puppetlabs/puppetlabs-transition/tree/0.1.2) (2020-02-25) -### Note: this version was not released due to an error in the pipeline. Apologies for any confusion. - [Full Changelog](https://github.com/puppetlabs/puppetlabs-transition/compare/0.1.1...0.1.2) -**Merged pull requests:** +### Fixed -- \(MODULES-10567 \) Release 0.1.2 [\#12](https://github.com/puppetlabs/puppetlabs-transition/pull/12) ([binford2k](https://github.com/binford2k)) -- Mark compatible with Puppet 4, 5 and 6 [\#11](https://github.com/puppetlabs/puppetlabs-transition/pull/11) ([ekohl](https://github.com/ekohl)) -- Fix spurious trigger with ensure =\> absent while other properties are set [\#10](https://github.com/puppetlabs/puppetlabs-transition/pull/10) ([philomory](https://github.com/philomory)) +- \(MODULES-8215\) Fix spurious trigger with ensure =\> absent while other properties are set [\#10](https://github.com/puppetlabs/puppetlabs-transition/pull/10) ([philomory](https://github.com/philomory)) ## [0.1.1](https://github.com/puppetlabs/puppetlabs-transition/tree/0.1.1) (2017-04-13) [Full Changelog](https://github.com/puppetlabs/puppetlabs-transition/compare/0.1.0...0.1.1) -**Merged pull requests:** +### Added -- \(MODULES-4734\) release 0.1.1 prep [\#9](https://github.com/puppetlabs/puppetlabs-transition/pull/9) ([eputnam](https://github.com/eputnam)) -- Clear cached provider properties after transition [\#8](https://github.com/puppetlabs/puppetlabs-transition/pull/8) ([Sharpie](https://github.com/Sharpie)) -- Add os support information to metadata.json [\#7](https://github.com/puppetlabs/puppetlabs-transition/pull/7) ([reidmv](https://github.com/reidmv)) -- Don't use smart quotes [\#6](https://github.com/puppetlabs/puppetlabs-transition/pull/6) ([elyscape](https://github.com/elyscape)) - Add validation to transition type [\#5](https://github.com/puppetlabs/puppetlabs-transition/pull/5) ([elyscape](https://github.com/elyscape)) - fix a very minor typo [\#4](https://github.com/puppetlabs/puppetlabs-transition/pull/4) ([awaxa](https://github.com/awaxa)) -- Add metadata summary per FM-1523 [\#3](https://github.com/puppetlabs/puppetlabs-transition/pull/3) ([laurenrother](https://github.com/laurenrother)) + +### Fixed + +- Clear cached provider properties after transition [\#8](https://github.com/puppetlabs/puppetlabs-transition/pull/8) ([Sharpie](https://github.com/Sharpie)) ## [0.1.0](https://github.com/puppetlabs/puppetlabs-transition/tree/0.1.0) (2014-11-18) [Full Changelog](https://github.com/puppetlabs/puppetlabs-transition/compare/1d08a765232c701d0bc5ec124f12998300af30dc...0.1.0) -**Merged pull requests:** +### Fixed - Fix issues URL [\#2](https://github.com/puppetlabs/puppetlabs-transition/pull/2) ([underscorgan](https://github.com/underscorgan)) -- Prep for 0.1.0 release [\#1](https://github.com/puppetlabs/puppetlabs-transition/pull/1) ([underscorgan](https://github.com/underscorgan)) diff --git a/REFERENCE.md b/REFERENCE.md index c625b36..3544eab 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,15 +1,16 @@ # Reference + ## Table of Contents -**Resource types** +### Resource types * [`transition`](#transition): Define a transitional state. ## Resource types -### transition +### `transition` Define a transitional state. @@ -19,40 +20,51 @@ The following properties are available in the `transition` type. ##### `enable` -Valid values: `true`, `false` +Valid values: ``true``, ``false`` Enable or disable this conditional state transition. Valid values are true or false. -Default value: true +Default value: `true` #### Parameters The following parameters are available in the `transition` type. -##### `resource` - -The resource for which a transitional state is being defined. This -should be a resource reference (e.g. Service['apache']). This resource -will be made to autorequire the transitional state. +* [`attributes`](#attributes) +* [`name`](#name) +* [`prior_to`](#prior_to) +* [`provider`](#provider) +* [`resource`](#resource) -##### `attributes` +##### `attributes` The hash of attributes to set on the resource when applying a transitional state. Each hash key must be a valid attribute for the resource being transitioned. -##### `prior_to` +##### `name` + +namevar + +This parameter does not serve any function beyond setting the +resource's name. + +##### `prior_to` An array of resources to check for synchronization. If any of these resources are out of sync (change pending), then this transitional state will be applied. These resources will each be made to autorequire the transitional state. -##### `name` +##### `provider` -namevar +The specific backend to use for this `transition` resource. You will seldom need to specify this --- Puppet will usually +discover the appropriate provider for your platform. -This parameter does not serve any function beyond setting the -resource's name. +##### `resource` + +The resource for which a transitional state is being defined. This +should be a resource reference (e.g. Service['apache']). This resource +will be made to autorequire the transitional state. diff --git a/metadata.json b/metadata.json index b8b1a4c..ba8c427 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-transition", - "version": "0.1.3", + "version": "1.0.0", "author": "puppetlabs", "summary": "Provides a Puppet type and provider for describing conditional transition states.", "license": "Apache-2.0", @@ -10,7 +10,7 @@ "dependencies": [ ], - "operatingsystem_support": [ + "operatingsystem_support": [ { "operatingsystem": "RedHat", "operatingsystemrelease": [ @@ -110,4 +110,3 @@ "template-url": "https://github.com/puppetlabs/pdk-templates#main", "template-ref": "heads/main-0-g0544f64" } -