Version Packages

packages/integration/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @backstage/integration
 
+## 0.4.0
+
+### Minor Changes
+
+- ffffea8e6: Update the `GitLabIntegrationConfig` to require the fields `apiBaseUrl` and `baseUrl`. The `readGitLabIntegrationConfig` function is now more strict and has better error reporting. This change mirrors actual reality in code more properly - the fields are actually necessary for many parts of code to actually function, so they should no longer be optional.
+
+  Some checks that used to happen deep inside code that consumed config, now happen upfront at startup. This means that you may encounter new errors at backend startup, if you had actual mistakes in config but didn't happen to exercise the code paths that actually would break. But for most users, no change will be necessary.
+
+  An example minimal GitLab config block that just adds a token to public GitLab would look similar to this:
+
+  ```yaml
+  integrations:
+    gitlab:
+      - host: gitlab.com
+        token:
+          $env: GITLAB_TOKEN
+  ```
+
+  A full fledged config that points to a locally hosted GitLab could look like this:
+
+  ```yaml
+  integrations:
+    gitlab:
+      - host: gitlab.my-company.com
+        apiBaseUrl: https://gitlab.my-company.com/api/v4
+        baseUrl: https://gitlab.my-company.com
+        token:
+          $env: OUR_GITLAB_TOKEN
+  ```
+
+  In this case, the only optional field is `baseUrl` which is formed from the `host` if needed.
+
 ## 0.3.2
 
 ### Patch Changes

packages/integration/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/integration",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
@@ -38,7 +38,7 @@
   },
   "devDependencies": {
     "@backstage/cli": "^0.6.0",
-    "@backstage/test-utils": "^0.1.5",
+    "@backstage/test-utils": "^0.1.7",
     "@types/jest": "^26.0.7",
     "@types/luxon": "^1.25.0",
     "msw": "^0.21.2"