mirror of
https://github.com/KumoCorp/kumomta.git
synced 2026-08-18 16:01:07 +00:00
Wez Furlong
a768c6dc79
This script is triggered as part of `make test` which is not really a great place for it. Its purpose is to extract the auto-generated openapi spec from the kumod and tsa binaries and update the snapshot that is present in the docs. It needs kumod and tsa-daemon to have been built in debug mode to run successfully. It piggy-backs on `make test` on the assumption that it will cause the person who is making changes to it to include those spec updates in their commit/PR. Since `make test` invokes it, the various builders may try and fail to execute jq in the `test` step. This is mostly harmless, but looks noisy in the logs. The ideal situation for this would be: * at PR time and push time: add a check that runs this script and that fails if the specs are updated for the docs and are not part of the PR itself. (eg: status is dirty after running it). This way it will be visible from the CI state that something is awry.