Sort object types before writing markdown file #874
Merged
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.
This PR sorts the object types written to generated markdown files alphabetically by name. It's an attempt to make PRs that alter what qualifies as a resource (e.g., #805) easier to review.
Currently, the order in which types appear in generated markdown files is determined by when they are used in a provider's swagger model. As a consequence, when a PR expands the definition of what qualifies as a resource, that can cause shapes to change position in the
.md
file, leading to a bunch of noise in the resulting diff, e.g.:With a stable sort, the diff for
.md
files would just be insertions.