Autogenerated Module Readme does not include the PowerShell or Puppet Module Names

[michaeltlombardi]

Describe the Bug

The autogenerated module readmes should include:

• the Puppet Module name as the first level header
• The PowerShell module name and link to the module in several places (link depends on the name)

This is because New-PuppetDscModule calls Update-PuppetModuleReadme without passing either the $PowerShellModuleName or $PuppetModuleName parameters:

Puppet.Dsc/src/functions/New-PuppetDscModule.ps1

Line 139 in 99a9e99

Update-PuppetModuleReadme -PuppetModuleFolderPath $PuppetModuleRootFolderDirectory -PowerShellModuleManifestPath $PowerShellModuleManifestPath

Those values need to be passed to Update-PuppetModuleReadme as that function uses them when calling Get-ReadmeContent:

Puppet.Dsc/src/internal/functions/Update-PuppetModuleReadme.ps1

Lines 47 to 55 in 99a9e99

	$ReadmeParameters = @{
	PowerShellModuleName = $PowerShellModuleName
	PowerShellModuleDescription = $PowerShellMetadata.Description
	PowerShellModuleGalleryUri = "https://www.powershellgallery.com/packages/$PowerShellModuleName/$($PowerShellMetadata.ModuleVersion)"
	PowerShellModuleProjectUri = $PowerShellMetadata.PrivateData.PSData.ProjectUri
	PowerShellModuleVersion = $PowerShellMetadata.ModuleVersion
	PuppetModuleName = $PuppetModuleName
	}
	$ReadmeContent = Get-ReadmeContent @ReadmeParameters

Where they are then used several times:

• Puppet.Dsc/src/internal/functions/Get-ReadmeContent.ps1

  Line 59 in 99a9e99

  # $PuppetModuleName

• Puppet.Dsc/src/internal/functions/Get-ReadmeContent.ps1

  Line 70 in 99a9e99

  This is an auto-generated module, using the [Puppet DSC Builder]($BuilderModuleGalleryUri) to vendor and expose the [$PowerShellModuleName]($PowerShellModuleGalleryUri) PowerShell module's DSC resources as Puppet resources.

• Puppet.Dsc/src/internal/functions/Get-ReadmeContent.ps1

  Line 71 in 99a9e99

  The _functionality_ of this module comes entirely from the vendored PowerShell resources, which are pinned at [**v$PowerShellModuleVersion**]($PowerShellModuleGalleryUri).

Acceptance Criteria

• The call to Update-PuppetModuleReadme in New-PuppetDscModule includes the missing parameters
• All of the parameters in Update-PuppetModuleReadme are marked as mandatory and validation prevents passing null or empty values
  • convert from [string] to [Parameter(Mandatory=$true)][ValidateNotNullOrEmpty()][String]
• Additional unit tests for when Update-PuppetModuleReadme is passed null and empty string values
• The $PowerShellModuleName and $PuppetModuleName parameters in Get-ReadmeContent are marked as mandatory and validation prevents passing null or empty values for any parameter
  • convert from [string] to [Parameter(Mandatory=$true)][ValidateNotNullOrEmpty()][String]
• Additional unit tests for when Get-ReadmeContent is passed null and empty string values for $PowerShellModuleName and $PuppetModuleName
• Changelog Fixed Entries:
  • Entry clarifying fixes for auto-generated readmes
  • Entry clarifying improved UX to prevent failed behavior when passing null/empty strings to Update-PuppetModuleReadme
  • Entry clarifying improved UX to prevent failed behavior when passing null/empty strings to Get-ReadmeContent

[david22swan]

In regards to the setting of $PuppetModuleName as mandatory, have decided to forgo this as code exists to use the $PowerShellModuleName in it's place if it was not given.