Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Build-PSBuildMarkdown.ps1 #67

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Dylan-Prins
Copy link

@Dylan-Prins Dylan-Prins commented Feb 9, 2024

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

  • 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:

  • 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.

@HeyItsGilbert
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants