PowerShellBuild icon indicating copy to clipboard operation
PowerShellBuild copied to clipboard

Update Build-PSBuildMarkdown.ps1

Open Dylan-Prins opened this issue 1 year ago • 1 comments

Updated New-MarkdownHelp with force parameter

Description

New-MarkdownHelp should always overwrite new old markdown pages. If this is not suitable a parameter should be added to be able to force it.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • [x] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [x] My code follows the code style of this project.
  • [ ] My change requires a change to the documentation.
  • [ ] I have updated the documentation accordingly.
  • [ ] I have read the CONTRIBUTING document.
  • [ ] I have added tests to cover my changes.
  • [ ] All new and existing tests passed.

Dylan-Prins avatar Feb 09 '24 08:02 Dylan-Prins

While I personally agree with you that the markdown files should be overwritten, the comment above seems to indicate that the previous expectation was to not.

# ErrorAction set to SilentlyContinue so this command will not overwrite an existing MD file.

I think the easiest way to handle this would be to accept a parameter in the function. Then we can add a Psake property to forcefully overwrite it. We can change the default in the next major version if we can come to a consensus.

HeyItsGilbert avatar Oct 04 '24 14:10 HeyItsGilbert

Rebased off of main and signed all the commits.

HeyItsGilbert avatar Mar 31 '25 14:03 HeyItsGilbert

Looks like I can't force push this required signatures. Going to handle this in #73.

HeyItsGilbert avatar Mar 31 '25 15:03 HeyItsGilbert