Version Packages

packages/backend-common/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/backend-common
 
+## 0.3.0
+
+### Minor Changes
+
+- 1722cb53c: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.
+
+  The new `loadConfigSchema` function exported by `@backstage/config-loader` allows for the collection and merging of configuration schemas from all nearby dependencies of the project.
+
+  A configuration schema is declared using the `https://backstage.io/schema/config-v1` JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the custom `visibility` keyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values are `frontend`, `backend`, and `secret`, where `backend` is the default. A visibility of `secret` has the same scope at runtime, but it will be treated with more care in certain contexts, and defining both `frontend` and `secret` for the same value in two different schemas will result in an error during schema merging.
+
+  Packages that wish to contribute configuration schema should declare it in a root `"configSchema"` field in `package.json`. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either `.json` or `.d.ts` format.
+
+  TypeScript configuration schema files should export a single `Config` type, for example:
+
+  ```ts
+  export interface Config {
+    app: {
+      /**
+       * Frontend root URL
+       * @visibility frontend
+       */
+      baseUrl: string;
+    };
+  }
+  ```
+
+- 8e2effb53: Refactored UrlReader.readTree to be required and accept (url, options)
+
+### Patch Changes
+
+- 1722cb53c: Added configuration schema
+- 7b37e6834: Added the integration package
+- Updated dependencies [1722cb53c]
+- Updated dependencies [7b37e6834]
+  - @backstage/config-loader@0.3.0
+  - @backstage/integration@0.1.1
+  - @backstage/test-utils@0.1.3
+
 ## 0.2.1
 
 ### Patch Changes

packages/backend-common/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-common",
   "description": "Common functionality library for Backstage backends",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "private": false,
@@ -31,9 +31,9 @@
   "dependencies": {
     "@backstage/cli-common": "^0.1.1",
     "@backstage/config": "^0.1.1",
-    "@backstage/config-loader": "^0.2.0",
-    "@backstage/integration": "^0.1.0",
-    "@backstage/test-utils": "^0.1.2",
+    "@backstage/config-loader": "^0.3.0",
+    "@backstage/integration": "^0.1.1",
+    "@backstage/test-utils": "^0.1.3",
     "@types/cors": "^2.8.6",
     "@types/express": "^4.17.6",
     "compression": "^1.7.4",
@@ -66,7 +66,7 @@
     }
   },
   "devDependencies": {
-    "@backstage/cli": "^0.2.0",
+    "@backstage/cli": "^0.3.0",
     "@types/compression": "^1.7.0",
     "@types/concat-stream": "^1.6.0",
     "@types/fs-extra": "^9.0.3",