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

Add -Ordered parameter info to documentation #115

Open
frankvaneykelen-work opened this issue Aug 29, 2023 · 1 comment
Open

Add -Ordered parameter info to documentation #115

frankvaneykelen-work opened this issue Aug 29, 2023 · 1 comment

Comments

@frankvaneykelen-work
Copy link

I had an issue with an azure DevOps build YAML file that was generated via loading it from a template (ConvertFrom-Yaml), processing it, and saving it (ConvertTo-Yaml). In the resulting file the properties of nodes in the YAML were in a different order than in the original template, causing the build configuration to be rejected ("The first property must be 'repository'").

The fix was easy - running it with the -Ordered parameter

ConvertFrom-Yaml -Ordered

I discovered it via running get-help ConvertFrom-Yaml but it would be nice if this parameter was covered in the docs too. Also because the other two (-UseMergingParser and -AllDocuments) are already mentioned.

@gabriel-samfira
Copy link
Member

You're right. Documentation is sorely missing. I'll allocate some time to write proper doc strings for each function and options. and also update the README.

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

No branches or pull requests

2 participants