bito-code-review[bot] commented on PR #43841:
URL: https://github.com/apache/superset/pull/43841#issuecomment-5534490850
<!-- Bito Reply -->
Yes, the regenerated artifact should be included in the PR. The current
workflow is designed to enforce that the checked-in `openapi.json` matches the
output generated by the project's pinned dependencies and configuration. If the
spec changes during the check, it indicates that the committed file is stale or
was generated in an environment that does not match the project's requirements.
To resolve the failure, you should regenerate the spec locally using the exact
environment specified in the workflow steps and commit the updated
`openapi.json` to the PR.
**.github/workflows/check-openapi-spec-drift.yml**
```
- name: Assert the published spec is up to date
run: |
if ! git diff --quiet -- docs/static/resources/openapi.json; then
echo "::error::docs/static/resources/openapi.json is stale."
echo "Regenerate it on the pinned requirements, with no config
file:"
echo " SUPERSET__SQLALCHEMY_DATABASE_URI='sqlite:///:memory:' \"
echo " FLASK_APP='superset.app:create_app()' superset
update-api-docs"
git diff --stat -- docs/static/resources/openapi.json
exit 1
fi
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
