Refactor st2-generate-schemas
to be importable
#5708
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.
Background
I'm working towards introducing
pants
. One of the first things we will use it for is linting / reformatting (it will run black, flake8, etc). Schema generation should happen more regularly, so we'll hook that up so pants runs it when it runs fmt and other tools.When pants runs these tools, however, it (or rather PEX, which pants uses), it needs to import the python code. Our script, however, is a kebab-case-file, so python cannot import from it. (Eventually, this will not be a requirement. PEX has been updated to handle this, so pants just needs to have the new option plumbed in before we can use it. For now, though, pants can only run importable python files.)
Overview
Currently schema generation is often missed, so the schemas often get out of date. We have some CI to catch this, but it doesn't error in every case, so there's one API schema that actually needs to be regenerated.
So, this PR does the following: