Fix generated docs to keep them consistent #83
Merged
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
Make them private and only handled via the init/update repo cmdlets. It's the only time we ever really want to set these ourselves.
Not quite finished yet but it does the basics ok.
We were getting some false positives.
Try to conform with https://common-changelog.org/ a bit more. We're not 100% complient as we do our features a little diffrently at the moment.
Formats Markdown on our PlatyPS content. Also breaks down the builds into smaller chunks as it was tedious having to generate the docs everytime.
Instead of being too rigerous with our regex matching be a bit more relaxed and instead have test cases for things so we don't get greedy with our matches. Also documents our thought process (and a cry for help lol)
When we've formatted the markdown we return a string. If the markdown hasn't been formatted then we were returning an array. Convert it to a string first
It wasn't doing the right things
Previously the docs had many linting issues. This makes the docs complient with markdownlint
Explain why this exists and link to the GitHub issue
Previously we formatted the documentation and changelog in the builds. Instead lets format them as part of the cmdlets that create them. This is cleaner and more consistent across workflows.
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.
Previously when generating our Markdown docs using PlatyPS the formatting would flip-flop between runs due to PowerShell/platyPS#593 (or some variation of it).
The generated documentation also breaks several
markdownlintrules which made reading these docs quite painful and working with them very tedious.Now we forcefully lint them and also set the line endings as part of the
Build-ModuleDocumentationcmdlet.We also set line endings on the
Add-BrownserveChangelogEntrycmdlet to which has allowed us to streamline our builds considerably (and reduced build times! 🎉)Most of the changes here are linting of the docs