From 66b7af4217ae951fdbe87f666ccab5180cfc1e46 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 26 Aug 2024 13:40:14 +0200 Subject: [PATCH] chore: tweak wording, fix config docs Signed-off-by: Johan Haals --- .changeset/wild-buses-notice.md | 2 +- packages/backend-defaults/config.d.ts | 10 ++-------- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/.changeset/wild-buses-notice.md b/.changeset/wild-buses-notice.md index 7c67ec685b..3620786aa8 100644 --- a/.changeset/wild-buses-notice.md +++ b/.changeset/wild-buses-notice.md @@ -2,4 +2,4 @@ '@backstage/backend-defaults': patch --- -Added the option to skip database migrations by setting `skipMigrations: true` in options. This can be done globally in the database config or by plugin id. +Added the option to skip database migrations by setting `skipMigrations: true` in config. This can be done globally in the database config or by plugin id. diff --git a/packages/backend-defaults/config.d.ts b/packages/backend-defaults/config.d.ts index 35de7ccdac..a13e90e39f 100644 --- a/packages/backend-defaults/config.d.ts +++ b/packages/backend-defaults/config.d.ts @@ -425,10 +425,7 @@ export interface Config { pluginDivisionMode?: 'database' | 'schema'; /** Configures the ownership of newly created schemas in pg databases. */ role?: string; - /** - * Skip running database migrations. - * NOTE: Currently only supported by the `pg` client. - */ + /** Skip running database migrations. */ skipMigrations?: boolean; /** * Arbitrary config object to pass to knex when initializing @@ -468,10 +465,7 @@ export interface Config { knexConfig?: object; /** Configures the ownership of newly created schemas in pg databases. */ role?: string; - /** - * Skip running database migrations. - * NOTE: Currently only supported by the `pg` client. - */ + /** Skip running database migrations. */ skipMigrations?: boolean; }; };