From 80bf8c7f4fb97f2af0dbefce0fabb42980de50c8 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 17 Nov 2020 18:26:40 +0100 Subject: [PATCH] cli: rename config:validate to config:check --- .github/workflows/ci.yml | 2 +- .github/workflows/master.yml | 2 +- docs/conf/defining.md | 6 +++--- docs/conf/index.md | 2 +- packages/cli/src/commands/index.ts | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 00ed9ce714..c35e2a88ff 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -73,7 +73,7 @@ jobs: run: yarn prettier:check - name: validate config - run: yarn backstage-cli config:validate + run: yarn backstage-cli config:check - name: lint run: yarn lerna -- run lint --since origin/master diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml index 4c20194f32..ca63e627e9 100644 --- a/.github/workflows/master.yml +++ b/.github/workflows/master.yml @@ -48,7 +48,7 @@ jobs: # End of yarn setup - name: validate config - run: yarn backstage-cli config:validate + run: yarn backstage-cli config:check - name: lint run: yarn lerna -- run lint diff --git a/docs/conf/defining.md b/docs/conf/defining.md index d231320e93..ead5c4ff67 100644 --- a/docs/conf/defining.md +++ b/docs/conf/defining.md @@ -85,9 +85,9 @@ declare the visibility of a leaf node of `type: "string"`. ## Validation -Schemas can be validated using the `backstage-cli config:validate` command. If -you want to validate anything else than the default `app-config.yaml`, be sure -to pass in all of the configuration files as `--config ` options as well. +Schemas can be validated using the `backstage-cli config:check` command. If you +want to validate anything else than the default `app-config.yaml`, be sure to +pass in all of the configuration files as `--config ` options as well. To validate and examine the frontend configuration, use the `backstage-cli config:print --frontend` command. Just like for validation you diff --git a/docs/conf/index.md b/docs/conf/index.md index 48da4eb74e..a6f1d1f6f7 100644 --- a/docs/conf/index.md +++ b/docs/conf/index.md @@ -43,7 +43,7 @@ custom `visibility` keyword, as configuration is by default only available in the backend. You can validate your configuration against the schema using -`backstage-cli config:validate`, and define a schema for your own plugin either +`backstage-cli config:check`, and define a schema for your own plugin either using JSON Schema or TypeScript. For more information, see [Defining Configuration](./defining.md). diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts index 304b5bae8f..1ebe518cac 100644 --- a/packages/cli/src/commands/index.ts +++ b/packages/cli/src/commands/index.ts @@ -147,7 +147,7 @@ export function registerCommands(program: CommanderStatic) { .action(lazy(() => import('./config/print').then(m => m.default))); program - .command('config:validate') + .command('config:check') .option(...configOption) .description( 'Validate that the given configuration loads and matches schema',