Merge pull request #274 from puppetlabs/release-prep

Release prep v2.0.0

CHANGELOG.md

@@ -5,6 +5,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/puppetlabs/Puppet.Dsc/tree/2.0.0) - 2023-11-13
+
+[Full Changelog](https://github.com/puppetlabs/Puppet.Dsc/compare/1.0.6...2.0.0)
+
+### Changed
+- (CAT-1454) - Add Puppet 8/Drop Puppet 6 [#273](https://github.com/puppetlabs/Puppet.Dsc/pull/273) ([jordanbreen28](https://github.com/jordanbreen28))
+- (CAT-1484) - Add ensurable property to resource [#269](https://github.com/puppetlabs/Puppet.Dsc/pull/269) ([jordanbreen28](https://github.com/jordanbreen28))
+
 ## [1.0.6](https://github.com/puppetlabs/Puppet.Dsc/tree/1.0.6) - 2023-08-25
 
 [Full Changelog](https://github.com/puppetlabs/Puppet.Dsc/compare/1.0.5...1.0.6)

docs/ConvertTo-PuppetResourceApi.md

@@ -0,0 +1,111 @@
+---
+external help file: Puppet.Dsc-help.xml
+Module Name: puppet.dsc
+online version:
+schema: 2.0.0
+---
+
+# ConvertTo-PuppetResourceApi
+
+## SYNOPSIS
+Collate the information about a DSC resource for building a Puppet resource_api type and provider
+
+## SYNTAX
+
+### ByObject (Default)
+```
+ConvertTo-PuppetResourceApi [-DscResource <DscResourceInfo[]>] [<CommonParameters>]
+```
+
+### ByProperty
+```
+ConvertTo-PuppetResourceApi [-Name <String[]>] [-Module <Object>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+This function takes a DSC resource and returns the representation of that resource for the Puppet
+Resource API types and providers as a PowerShell object for further use.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-DscResource -Name PSRepository | ConvertTo-PuppetResourceApi -OutVariable Foo
+```
+
+Retrieve the representation of a Puppet Resource API type and provider from a DSC Resource object.
+
+### EXAMPLE 2
+```
+ConvertTo-PuppetResourceApi -Name PSRepository
+```
+
+Retrieve the representation of a Puppet Resource API type by searching for a DSC resource object via
+Get-DscResource.
+Will ONLY find the resource if it is in the PSModulePath.
+
+## PARAMETERS
+
+### -DscResource
+The DscResourceInfo object to convert; can be passed via the pipeline, normally retrieved
+via calling Get-DscResource.
+
+```yaml
+Type: DscResourceInfo[]
+Parameter Sets: ByObject
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -Name
+If not passing a full object, specify the name of the DSC Resource to retrieve and convert.
+
+```yaml
+Type: String[]
+Parameter Sets: ByProperty
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Module
+If not passing a full object, specify the module name of the the DSC Resource to retrieve and convert.
+Can be either a string or a hash containing the keys ModuleName and ModuleVersion.
+
+```yaml
+Type: Object
+Parameter Sets: ByProperty
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+This function currently takes EITHER:
+
+1.
+A DscResource Object, as passed by Get-DSCResource
+2.
+A combo of name/module to retrieve DSC Resources from
+
+## RELATED LINKS

docs/Export-PuppetModule.md

@@ -0,0 +1,111 @@
+---
+external help file: Puppet.Dsc-help.xml
+Module Name: puppet.dsc
+online version:
+schema: 2.0.0
+---
+
+# Export-PuppetModule
+
+## SYNOPSIS
+Build a Puppet module with the PDK
+
+## SYNTAX
+
+```
+Export-PuppetModule [-PuppetModuleFolderPath] <String> [[-ExportFolderPath] <String>] [-Force] [-PassThru]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Build a Puppet module with the PDK as a .tar.gz
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Export-PuppetModule -PuppetModuleFolderPath ./import/powershellget
+```
+
+This command will invoke the PDK to build the powershellget module in the
+specified folder path.
+
+## PARAMETERS
+
+### -PuppetModuleFolderPath
+The path to the folder where the Puppet module to build exists
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExportFolderPath
+The path to the folder for the built module to be placed in.
+If not specified,
+builds in the pkg folder inside the PuppetModuleFolderPath.
+If the specified
+ExportFolderPath does not exist, the PDK will create it.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Force
+Specify this switch to force a build of the module even if it already exists
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PassThru
+Specify this switch to capture the output of the PDK build command and return it
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None.
+## OUTPUTS
+
+### [Object[]] If the PassThru switch is specified, returns the output from the
+### PDK execution, including any error records.
+## NOTES
+
+## RELATED LINKS

docs/Get-ForgeModuleInfo.md

@@ -0,0 +1,119 @@
+---
+external help file: Puppet.Dsc-help.xml
+Module Name: puppet.dsc
+online version:
+schema: 2.0.0
+---
+
+# Get-ForgeModuleInfo
+
+## SYNOPSIS
+Search a Puppet forge for modules with DSC Resources
+
+## SYNTAX
+
+### ByNameSpace (Default)
+```
+Get-ForgeModuleInfo -ForgeNameSpace <String> [-ForgeSearchUri <String>] [-PaginationBump <Int32>]
+ [<CommonParameters>]
+```
+
+### ByName
+```
+Get-ForgeModuleInfo -ForgeNameSpace <String> -Name <String[]> [-ForgeSearchUri <String>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Search a Puppet forge for modules with DSC Resources, returning their name,
+every release of that module, and the module's PowerShell metadata.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-ForgeModuleInfo -Name powershellget
+```
+
+Search the DSC namespace of the Puppet Forge for the powershellget module,
+returning it (if it exists) with the list of releases and the metadata for
+the PowerShell module it was built from.
+
+## PARAMETERS
+
+### -ForgeNameSpace
+The namespace on the Forge to search for modules.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Name
+The name of the module to search for on the Forge.
+If left unspecified, will
+search the entire namespace for modules.
+
+```yaml
+Type: String[]
+Parameter Sets: ByName
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ForgeSearchUri
+The URI to the forge api for retrieving modules; by default, the public
+Puppet forge (v3).
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: Https://forgeapi.puppet.com/v3/modules
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PaginationBump
+If searching a namespace for modules, indicates the number of modules to return
+in a single result set, continuing to search until no more modules are discovered.
+
+```yaml
+Type: Int32
+Parameter Sets: ByNameSpace
+Aliases:
+
+Required: False
+Position: Named
+Default value: 5
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None.
+## OUTPUTS
+
+### [PSCustomObject[]] One or more objects with the name, releases, and the
+### PowerShellModuleInfo properties.
+## NOTES
+
+## RELATED LINKS