Update docs for OPS13 #702
Closed
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
Add preview.1 is the PSData section of psd1
Remove dot from the preview version string
Fix publish template
* Update build script test to have better isolation when running in a dev environment. Also ignore Pester test result files. * update build script and fix indentation. Also remove some abbreviations. * Take version 0.33 of markdig.
* Add alias tracking to object model. Add tests for same. Refactor tests. * Updates reflecting sdwheeler comments. * Add test for the correct order of sub-headers.
* Initial refactor * Move commands to Command directory. * Major refactor. Add initial mark down converter (still in progress).Add many tests (yamlhelp tests are all pending). * Major refactor. Also add test assets for tests which are coming. Add tests for paragraph formatter. Add Markdown reader for CommandHelp. * Move some files around to reduce clutter in base directory. * Move resource files back. * Fix test failures on windows. Also mark an addition test in NewYamlHelp as pending. * Address feedback from Aditya. * change helpuris for cmdlets to be an empty string * address last feedback comments. * Remove get-yamlmetadata command as it is not needed.
* Implement IEquatable for CommandHelp and sub-types. Also add a bunch of tests. * Add additional tests for equality. * Fix case to match file. Improve the description of a couple tests. * Address PR #620 feedback. Add LiteralPath parameter to Import-MarkdownCommandHelp. Fix up some whitespace issues. Fix failing tests on ubuntu due to case sensitive file system. * Fix string comparison to use currentculture. In some cases, the comparison ignores case (parameter names), However, comparison against text fields is case sensitive to capture changes in capitalization. Add additional comments.
* checkpoint fixes needed for markdown/yaml roundtrips * Change CommandHelp from internal to public. Add additional tests for converting markdown to yaml (and test tools). Add shouldprocess support to export-yamlhelp. Add Import-MamlHelp command. * Add copyright statements. * Add debugging for dll import troubleshooting. * Change way that module base location is determined.
* Fix to markdown parser to add properties and syntaxes correctly. Use the CommandHelp methods for adding rather than just calling add on the collection. Fix tests due to bug fixes in the powershell-docs repo. Fix typo in the transform code. * Fix parser for pipeline input. * Emit an ETS populated fileinfo object. * Add MAML writer to project. Add Export-MamlCommandHelp which uses the MAML writer. Add tests for Export-MamlCommandHelp * Remove carrage return from expected string. * Fix case of assets to pass on linux. use [environment]::newline rather than `r`n * Also adjust the observed description text. * Mark the content comparison test as pending until I can find a reliable way to compare strings cross platform.
* Add parsing diagnostics plumbing. Add test-MarkdownCommandHelp cmdlet. * Add initial tests for Test-MarkdownCommandHelp. * Start adding diagnostics. * Copy pdb to module directory when building debug configuration. This improves the debugging experience. * Add diagnostics for parsing sections. Add tests for diagnostics.
Adding a syntax parser and writer. The output for syntax is now correct. Update New-MarkdownHelp so it emits an adapted fileinfo object.
* Update to new schema. This provides more information for parameters based on their parameter set. Also added a number of tests. Changed the way that we serialize the yaml blocks for parameters to use YamlDotNet to do the serialization rather than hand crafting it. * Remove some behaviors for MAML. This is due to MAML does not have the capabilities of the new schema, so we need to simplify that when converting to MAML. Add some explanitory comments for same. * remove temp code used to collect location of the markdig and yamldotnet assemblies.
* Remove some cmdlets. Change to version 1.0.0. * Change module name. And update the version. * Changes needed for name change. * Updates needed for name change in build scripts. * Module name changes in ci scripts. * Fix test to use proper name.
* changes needed for new cmdlets fix up one of the md files to ensure we get good tests. ensure we can order the parameters if desired. * new cmdlet and modulefile reader. * cp2 * add compare command. * Fix up diagnostic messages. Some of them were wrong. Added more diagnostics. * add encoding changes for better usability. improve compare-commandhelp to include object.property.property for better clarity.
* Change how we gather commands and modules for creating new markdown help. * Add another overload for base module file metadata and use it. * add transform from string to cmdlet and module. * update some tests, still some failures. * Only write progress if there are more than 10 commands. * Skip tests that use the old modulefilepath parameter. * a couple new overloads for base metadata for module files. * don't emit progress with fewer than 10 commands. * save off the module guids for use in the module file writer. * Change New-MarkdownCommandHelp dramatically. * Removed optional alpha sorting for parameters, this is always the case. * Change to use fulltypes for parameters by default. * Change to accept CommandInfo and PSModuleInfo objects. * A transform attribute will convert strings to objects rather than the transformer. * Add some overloads to the transformer to take those objects. * Files are grouped by module name, and placed in their own directory. * If they're not associated with a module (like a script), then they go into the 'outputfolder'. * Fix a bug in the markdown reader to include the first input or output if it doesn't have a description. * Added a bunch of tests for new-markdowncommandhelp. * move to net472 * Fix null reference issues found by moving to dotnet 9 sdk. * Fix up logic for reporting on parameter help message. * turn off progress for newmarkdown tests.
* Fix up compare-commandhelp to make it easier to see differences. Change test path in build script to add the output directory to psmodulepath. * cp * change export-maml again to create a base directory and put the files in it based on their module. * Fix tab completion for encoding parameter. * Update Export-YamlModuleFile to accept metadata additions. Add tests for same. * add formatting for test-markdowncommand. * Change some globbing references to supportsWildcards. * Fix test section of build.ps1 to properly add to psmodulepath * Fix input/output logic for new-commandhelp. * Fix up how we deal with additional metadata, and make it more consistent. Add tests.
* Fix input/output transformation from cmdlet. Also add output to cmdlets. Add a bunch of tests for new-commandhelp. * Fix typo Add debugging for failing test. * Mark a test as pending. get-help erroneously includes those parameters which take FromRemainingArguments as pipeline input. * Remove VariableLength from Parameter segment of serialized output. * Change the way we create the common parameters boilerplate. This will also more easily enable supporting different versions of the boilerplate text. * Change 'content type' to 'document type' * provide a default locale. * When saving commandhelp metadata, sort the keys. * Save module file metadata in alpha-order. * Fix up syntax parameters to report properly abbreviated types.
* Add support for ShouldProcess. Unify handling of skipped file warning. Add SupportsWildcards to those parameters that handle it. Add more tests. * Add synopsis to module landing page if it can be determined from help. * Add literalpath parameter to import-mamlhelp. Change error in export-MamlCommandHelp to warning. Fix error in MamlWriter to handle parameter position better. Fix tests broken by changes. Remove settings parameter in import-mamlhelp. * Remove extraneous whitespace at end of lines.
* Initial code for OneBranch build and gallery publish. * **BYPASS_SECRET_SCANNING** * remove debug from variables. * be sure to set the host to 1ESWindows2022. * Add global.json to satisfy build requirements. * Remove tsa upload branch, use default? * Fix up 3rd party dll search location. change name of zip file. fix location of .nupkg. * Add suppression file for asset file. Add a bit of debugging output. * Fix typo. * Add block for credscan configuration to globalSdlw. * Add the signed nupkg as a published artifact. * Remove the artifact publish and substitute archiving the nupkg. * Change nuget package configuration. * skip publisher check when installing pester.
Add ignore pattern for pester output
Add docs for Microsoft.PowerShell.PlatyPS v1 cmdlets
This will be used by the Update-MarkdownCommandHelp cmdlet.
* a number of bug fixes. Change ValueByPipeline to ValueFromPipeline. Add isDynamic as an attribute to parameter. Add Equality method without description to prepare easier updating. * Fix Export-MarkdownCommandHelp to create directories for modules * Add a test for a non-module function. Check to be sure the file is created in the correct place. * Add test to explicitly create multiple directories with export-markdowncommandhelp. * remove extraneous space
* Initial code for Update-MarkdownCommandHelp. It doesn't actually do the merge yet. * remove commented using statements. * first run at parameter updating. * Implement Update-CommandHelp and methods to facilitate it. Create tests for new cmdlet. Fix a number of miscellaneous issues found during implementation. Add 'document type' as a metadata key which should not be updated when metadata is passed in. Implement ToMarkdownString for CommandHelp. * skip no update test on windows due to line ending differences between windows/non-windows.
Update v2 docs from latest build
* Fix metadata parsing and serializing yaml needs to preserve the collection aspect. Fix a bunch of white space issues. Change module file object model to have groups of cmdlets, rather than a flat list. * Metadata is now a string/object dictionary, since the value may be an array. Create a serializer for that dictionary to support in flow style (array elements on a single line). Add the dlls to the nested module list (as these need to be loaded before the module assembly is loaded due to the flow style change. Explicitly sort the metadata before serializing it. Fix parser bug for the last ast. Change the object model for the module file due to requirement to handle multiple command groups (supporting exchange). Add diagnostics for module file.
Fix issue with module parsing when schema was not present. Fix up tests for same and add exchange module file (for tests against multiple command groups. Refactor a number of files. Change metadata dictionary to be <string,object> rather than <string,string>. Add handling of HelpUri and HelpInfoUri to new-markdowncommandhelp (transform settings does not preserve these). Update metadata serializer to handle arrays in flow format. Add a reasonable implementation of ToString for DiagnosticMessages to improve formatting. Be sure to include aliases in commandhelp. Add support for metadata as a paragraph in addition to normal handling. Add a number of diagnostic messages throughout. Change alias boilerplate to appear only if the ALIAS header was missing. This means that the first conversion from V1 -> V2 will include boilerplate, but V2 -> V2 will not. Don't add empty lines for the description of ModuleCommands, only if description is present. Add a number of format entries for DiagnosticMessage, Iditify, Diagnostics (now a custom format). Add Update-MarkdownModuleFile, Measure-PlatyPSMarkdown (identify what kind of markdown we have). * Add metadata during import of MAML file. * Change parameter name to from OutputDirectory to OutputFolder for Export-MamlCommandHelp. Be sure to save command help notes as AlertSet. Be sure to create metadata when importing MAML file. * fix issue in Measure-PlatyPSMarkdown. It was not identifying a V2 module file. Add a test for same. * Set diagnostics and ParameterNames as skipped property names for Compare-CommandHelp. * updates to helpinfouri and helpuri. Be sure that they go in the right file. * use CurrentCulture rather than CurrentUICulture * Be sure to default metadata Locale to en-US. * Skip implicit loading of module in Windows PowerShell. * When testing, be sure to execute the right powershell. * Fixes to build script to ensure testing on Windows PowerShell. * Rewrite of tests to support running on Windows PowerShell.
* Add should process support to more cmdlets. Rename a number of parameters for better consistency. Remove string to cmdletinfo and string to psmoduleinfo support. Add a number of tests. Fix metadata support to ensure not overriding special values. update ms.date metadata to be current date for update cmdlets. * Change Update-MarkdownModuleFile to behave more like Update-MarkdownCommandHelp. Create tests for same. Add formatting for CommandHelp. Update New-MarkdownModuleFile to preserve the synopsis when creating the module file. Add a couple of helpers to MarkdownProbeInfo to make it easier to determine whether the file is a ModuleFile or CommandHelp. * Change module backup test to use ticks and be greater or equal.
Update v2 docs for OPS10 build
* cp SyntaxParameter constructor from Parameter incomplete. Improve error messages for update cmdlets. Add identity check to Update-MarkdownCommandHelp. * Remove extraneous using statements. * Refactor ValidationResult into MarkdownReader. Isolate cmdlets from any specific serialization/deserialization. * remove extraneous using statements. * Remove extraneous using statements. Fix bug in ProbeInfo enum for identifying file type. Add summaries for members. * Fix tests * remove stringtocommand transform attribute. It wasn't very stable, and the failure modes were opaque to the user. * Fix maml writer to not duplicate the example title. Add test for same. * Add AliasHeaderFound to skipped properties for compare. This member is also not used for equality. * Add module directory to Export-MarkdownModuleFile. Adjust tests for new behavior. * Set AliasHeaderFound to true in update command help. This ensures that we won't put the boiler plate in for aliases. Add test for same. Also use PowerShellAPI helper to get cmdinfo to improve reliability. * Add AliasHeaderFound to skipped properties for compare tests. * Improve error message for Import-YamlModuleFile if the file is not a module file. Be sure to set AliasHeaderFound to true to avoid emitting the boilerplate for alias when updating command help. Remove extraneous using statements. When importing yaml command help set the notes to an empty string if it is null. Fix tests for Export-MarkdownCommandHelp. Add additional tests for HelpUri to ensure it is not in the Update-MarkdownModule file output. Check to be sure that HelpInfoUri _is_ present. * Remove extraneous space. * Be sure to copy all the properties when calling the constructor of a parameter. Add test to update-commandhelp to validate it. * Fixes to Export-YamlModuleFile. Be sure to output the yaml module file in the proper location. Add test for same. Add support for ShouldProcess. * Remove extraneous comments. * Make sure all export commands create a module directory. Fix up tests to prove it. Fix up code for ShouldProcess. * Add tests for Update-MarkdownModuleFile. Be sure to check the update when -WhatIf is used. Add tests
Aliases are not a list, but unparsed markdown. Add some improved diagnostics for parsing yaml (more to do here) Improve diagnostics for alias scanning in markdown. Fix an issue in SyntaxItem parameter sorting to handle cases where a position may not be know (such as command help as generated by MAML). Change yaml serialization for aliases to use yaml serializer. Add copyright to exportyamlmodulefile tests. Add a new get-childitem v2 help file for testing aliases.
Update docs for OPS12
* Implement Show-PreviewHelp and New-HelpCabinetFile in psm1. update psd1 for psm1. add tests borrowed from v1. * Fix markdown parser to handle empty alias section. Fix for issue 391 Add tests for same. Add a helper for identifying an about_Topic in ProbeInfo. Add Get-Date.V2.md as an asset. * Revamp Update cmdlets - refactor into mergeutil class. - Both Update-CommandHelp and Update-MarkdownCommandHelp use same routine. - fix cmdlet transformer to not mess up the parameter order. - Don't abbreviate switch parameter. - Change parameter type to use PowerShell style '[' rather than c# '<' for generic types. * use constants rather than strings in the transformer. * Change type of cmdlet alias property. - It is now a string rather than a list of strings. - Update tests to handle the change. Support example title with markdown changes. - Add test for example title which includes emphasized text. * Fix up some issues in the cab builder. Also add tests for Show-HelpPreview * Remove references to System.Text.Json. Use the deserialization message to help the user locate the bad yaml. * Fix tsaoptions areaPath.
* Try new pipeline. This has a checkbox for publishing to the gallery. Created a new service connection 'PlatyPSGallery' which holds the apikey. * fix service connection name. * Use a deploybox to push the package to the gallery. * Update .pipelines/PlatyPS-Official.yml Co-authored-by: Aditya Patwardhan <adityap@microsoft.com> * Change code for publishing nupkg. It looks like the artifact contains a zipfile which contains the .nupkg, so there's a little dance to extract the nupkg from the zip. --------- Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
|
Abandoning PR |
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.
Update docs for OPS13