Add pre-commit script to keep tags sorted in OpenAPI spec#38813
Merged
potiuk merged 1 commit intoapache:mainfrom Apr 7, 2024
Merged
Add pre-commit script to keep tags sorted in OpenAPI spec#38813potiuk merged 1 commit intoapache:mainfrom
potiuk merged 1 commit intoapache:mainfrom
Conversation
Member
Author
1555864 to
45e46a9
Compare
Member
|
Yeah. Sometimes parsers are not the best in preserving thigns and old-good file reading + regexp is best. |
potiuk
approved these changes
Apr 7, 2024
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
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.




Following up with PR #38717, this PR adds a pre-commit hook
to keep the tags list sorted in the OpenAPI spec yaml.
I previously tried to use the pyyaml library, to find the tags
and rewrite sorted tags, but upon rewrite it does not maintain
the original order of components in the YAML thus creating
huge changes for the PR to review. Hence, taking a simple
approach to read the file line by line, find the indexes of the
start entry and end entry of the tags list, sort those specific lines
and rewrite the lines with the sorted list of tags.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.