Merge branch 'issue-24-automatic-release' into 'main'

feat: add OpenAPI schema to release artefacts

See merge request !58

.gitlab/openapi-generator-local.gitlab-ci.yml

@@ -5,6 +5,11 @@ variables:
   # 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:

.gitlab/openapi-generator.gitlab-ci.yml

@@ -69,6 +69,8 @@ openapi:schema:version:
   image:
     name: $OPENAPI_GENERATOR_YQ_IMAGE
     entrypoint: [""]
+  before_script:
+    - mkdir -p $(dirname "$OPENAPI_GENERATOR_SCHEMA_VERSION_ARTIFACT")
   script:
     - yq -r ".info.version" "$OPENAPI_GENERATOR_SCHEMA_ARTIFACT_PATH" >"$OPENAPI_GENERATOR_SCHEMA_VERSION_ARTIFACT"
   artifacts:

.release-it.json

@@ -4,7 +4,10 @@
   },
   "gitlab": {
     "release": true,
-    "releaseName": "${version}"
+    "releaseName": "${version}",
+    "assets": [
+      "openapi.yml"
+    ]
   },
   "plugins": {
     "@release-it/conventional-changelog": {