Automatically generate external help during build #167
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
Use Platyps to generate external help on build. This will minimise the number of extra files in the repo. We only need to maintain the MD docs in the repo itself.
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.
PR Summary
Modifies the build system to automatically generate external help for the module as the final build step, just before deployment.
Context
When I first added PlatyPS markdown files to the repo, I also added the external help XML so that I could push that to the gallery. It doesn't make sense to have both MD and XML versions of the help in the repo; the markdown should be "the help files", and the external help generation can be handled automatically by the build system.
Changes
en-us/folder from the PSKoans module folder.New-ExternalHelpcall to the build step of the Psake tasks.Platypsas a module to install pre-build in the Azure yml.Checklist