openapi-generator-local.gitlab-ci.yml

# *REPOSITORY LOCAL* specialisation of the OpenAPI generator templates.

variables:
  # We need to explicitly enable the OpenAPI generation since we don't have an openapi.yaml file in
  # the root of our repository which would otherwise signal that.
  OPENAPI_GENERATOR_ENABLED: "1"

  # Override the OpenAPI build artefact locations which are, in turn, added to the release-it
  # configuration. We set these here explicitly so that we can curate the naming of the release
  # assets.
  OPENAPI_GENERATOR_SCHEMA_ARTIFACT_PATH: openapi.yaml

# We do not ship the OpenAPI schema in the repository and so the openapi:schema job needs to be
# extended to create the schema.
openapi:schema:
  services:
    - docker:dind
  image:
    name: docker:latest
  script:
    - cp secrets.env.in secrets.env
    - docker compose run --rm manage spectacular --fail-on-warn --file "$OPENAPI_GENERATOR_SCHEMA_ARTIFACT_PATH"