Shorten help message for backend:build-image

This commit is contained in:
Joel Low
2020-12-03 17:47:22 +08:00
parent a6e9708ada
commit e0cd3aa7aa
+4 -2
View File
@@ -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)));