nevzheng opened a new issue, #12029: URL: https://github.com/apache/gravitino/issues/12029
### What would you like to be improved? Gravitino owns the OpenAPI source under `docs/open-api/`, but downstream consumers do not have a stable, versioned artifact containing the bundled specification. The OpenAPI workflow proposed in #11986 creates `openapi.yaml` and `openapi.json` and uploads them as a workflow-run artifact. However, the documentation site needs a release-oriented artifact that it can retrieve deterministically. Re-bundling or copying the source files in `gravitino-site` could allow the rendered reference and published raw specification to drift. This is needed by: - https://github.com/apache/gravitino-site/issues/138 - https://github.com/apache/gravitino/issues/11985 - https://github.com/apache/gravitino/pull/11986 ### How should we improve? Provide one supported CLI/build entry point that bundles `docs/open-api/openapi.yaml` into self-contained YAML and JSON files. This could be a Gradle task such as: ./gradlew :docs:bundleOpenApi or a documented equivalent backed by `dev/openapi`. Publish the resulting bundle from the build/release workflow using an explicit, versioned artifact name and a location that another repository can retrieve reliably. Acceptance criteria: - A documented command produces self-contained `openapi.yaml` and `openapi.json`. - The build/release workflow publishes those files as a clearly named, versioned artifact. - The artifact can be retrieved by an exact Gravitino release or documentation version. - The published files are generated from the same commit used for the release. - CI validates the bundle before publication. - `gravitino-site` can consume the artifact for its Docusaurus OpenAPI reference and raw-spec link without re-bundling it. -- 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]
