From e0cd3aa7aab35adfd75b906de989b7fda4919df1 Mon Sep 17 00:00:00 2001 From: Joel Low Date: Thu, 3 Dec 2020 17:47:22 +0800 Subject: [PATCH] Shorten help message for `backend:build-image` --- packages/cli/src/commands/index.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts index 975df97f41..db88c57fb1 100644 --- a/packages/cli/src/commands/index.ts +++ b/packages/cli/src/commands/index.ts @@ -55,9 +55,11 @@ export function registerCommands(program: CommanderStatic) { .helpOption(', --backstage-cli-help') // Let docker handle --help .option('--build', 'Build packages before packing them into the image') .description( + // TODO: Add example use cases in Backstage documentation. + // For example, if a $NPM_TOKEN needs to be exposed, run `backend:build-image --secret + // id=NPM_TOKEN,src=/NPM_TOKEN.txt`. 'Bundles the package into a docker image. All extra args are forwarded to ' + - '`docker image build`. For example, if a $NPM_TOKEN needs to be exposed, run ' + - '`backend:build-image --secret id=NPM_TOKEN,src=/NPM_TOKEN.txt`', + '`docker image build`.', ) .action(lazy(() => import('./backend/buildImage').then(m => m.default)));