Overwrite docs #73
Merged
Overwrite docs #73
Conversation
This file contains hidden or 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
* Introduced an `Overwrite` parameter to control the overwriting of existing markdown files. * Updated relevant functions and properties to utilize the new parameter.
* Added new rules for `MD013` to disable checks for code blocks and tables. * Documented breaking changes in `CHANGELOG.md` regarding UTF-8 file compilation and markdown file overwriting.
9 tasks
* Introduced a new `.PARAMETER Overwrite` to allow overwriting existing markdown files. * Updated the `New-MarkdownHelp` command to utilize the `Overwrite` parameter.
|
So the impact of this on existing users of PowerShellBuild is that if the markdown help files already exist, they'll be overwritten based on comment-based help if it is present? If so, then for someone like me who uses markdown as my source of truth, I'll have to add a line to set Should we overwrite files by default, or should we fail the build and suggest the user add |
…eter * Clarified the behavior of the `$PSBPreference.Docs.Overwrite` parameter. * Updated the default value from `$true` to `$false` in configuration files. * Enhanced error handling in `Build-PSBuildMarkdown` function.
|
I've decided to set the default to |
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.
Updated New-MarkdownHelp with force parameter.
This is a signed version of #67
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
This allows the comment based help to be the source of truth.
How Has This Been Tested?
Checklist: