(GH-153) Ensure generated readme contains module name info #163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
david22swan
force-pushed
the
#153/main/auto-generate_readme
branch
2 times, most recently
from
0a5d9c0
to
a6fda56
Compare
michaeltlombardi
suggested changes
Jun 2, 2021
There was a problem hiding this comment.
Could you also add a changelog entry to this (should get an entry in the Fixed section) and update the commit to be something like:
(GH-153) Ensure generated readme contains module name info
This commit corrects a bug where the auto-generated readme
was missing the PowerShell and Puppet module names from
various locations in the output markdown.
Those values were not being passed by New-PuppetDscModule
to Update-PuppetModuleReadme.
This commit also updates tests to ensure the values are passed.
Resolves #153
The changelog entry should match the format of the other entries (linking to the issue) and have a message like:
Ensure puppetized module READMEs include the PowerShell and Puppet module names where needed in the markdown.
michaeltlombardi
changed the title
david22swan
force-pushed
the
#153/main/auto-generate_readme
branch
11 times, most recently
from
089425a
to
01026f5
Compare
michaeltlombardi
suggested changes
Jun 3, 2021
This commit corrects a bug where the auto-generated readme was missing the PowerShell and Puppet module names from various locations in the output markdown. Those values were not being passed by New-PuppetDscModule to Update-PuppetModuleReadme.
…-PuppetModuleReadme` Makes all `Update-PuppetModuleReadme` parameters except `PuppetModuleName` mandatory and do not accept null or empty values. PuppetModuleName` is excluded from this change as it is handled by a separate set of logic that uses the `PowerShellModuleName` in its place should it not be set or be set as an empty string.
david22swan
force-pushed
the
#153/main/auto-generate_readme
branch
from
01026f5
to
28b7a99
Compare
…mecontent` Makes the `PowerShellModuleName` and `PuppetModuleName` parameters in `Get-Readmecontent` mandatory and rejects null or empty values for any parameters
david22swan
force-pushed
the
#153/main/auto-generate_readme
branch
from
28b7a99
to
c1deca4
Compare
|
Have updated the changelog and split the commit into 3 commits |
michaeltlombardi
approved these changes
Jun 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit corrects a bug where the auto-generated readme was missing the PowerShell and Puppet module names from various locations in the output markdown.
Those values were not being passed by New-PuppetDscModule to Update-PuppetModuleReadme.
Also includes work to increase parameter validation within
Update-PuppetModuleReadmeandGet-Readmecontentto help catch any empty or null values and make parameters mandatory.Resolves #153