From cb8b95aeec35c2c498aa83040f030f7be45be767 Mon Sep 17 00:00:00 2001 From: Aramis Sennyey Date: Wed, 11 Jan 2023 18:19:06 -0500 Subject: [PATCH 1/4] Fix documentation to match correct plugin URL. Signed-off-by: Aramis Sennyey --- docs/plugins/backend-plugin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/backend-plugin.md b/docs/plugins/backend-plugin.md index 517779d161..b9141236b5 100644 --- a/docs/plugins/backend-plugin.md +++ b/docs/plugins/backend-plugin.md @@ -48,7 +48,7 @@ This will think for a bit, and then say `Listening on :7007`. In a different terminal window, now run ```sh -curl localhost:7007/carmen/health +curl localhost:7007/carmen-backend/health ``` This should return `{"status":"ok"}`. Success! Press `Ctrl + c` to stop it From 77b75cea3e1f3c809a194448c1712992ead0543e Mon Sep 17 00:00:00 2001 From: Aramis Sennyey Date: Fri, 13 Jan 2023 15:26:39 -0500 Subject: [PATCH 2/4] Update pluginId in backend plugin creation. Signed-off-by: Aramis Sennyey --- .../cli/src/lib/new/factories/backendPlugin.test.ts | 9 +++++++++ packages/cli/src/lib/new/factories/backendPlugin.ts | 11 ++++++----- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/packages/cli/src/lib/new/factories/backendPlugin.test.ts b/packages/cli/src/lib/new/factories/backendPlugin.test.ts index f85d52c935..f326de88b8 100644 --- a/packages/cli/src/lib/new/factories/backendPlugin.test.ts +++ b/packages/cli/src/lib/new/factories/backendPlugin.test.ts @@ -100,6 +100,15 @@ describe('backendPlugin factory', () => { 'backstage-plugin-test-backend': '^1.0.0', }, }); + const standaloneServerFile = await fs.readFile( + '/root/plugins/test-backend/src/service/standaloneServer.ts', + 'utf-8', + ); + + expect(standaloneServerFile).toContain( + `const logger = options.logger.child({ service: 'test-backend' });`, + ); + expect(standaloneServerFile).toContain(`.addRouter('/test', router);`); expect(Task.forCommand).toHaveBeenCalledTimes(2); expect(Task.forCommand).toHaveBeenCalledWith('yarn install', { diff --git a/packages/cli/src/lib/new/factories/backendPlugin.ts b/packages/cli/src/lib/new/factories/backendPlugin.ts index 4d03a4da7b..c5c9b5bd0e 100644 --- a/packages/cli/src/lib/new/factories/backendPlugin.ts +++ b/packages/cli/src/lib/new/factories/backendPlugin.ts @@ -38,17 +38,18 @@ export const backendPlugin = createFactory({ }), optionsPrompts: [pluginIdPrompt(), ownerPrompt()], async create(options: Options, ctx: CreateContext) { - const id = `${options.id}-backend`; + const { id } = options; + const pluginId = `${id}-backend`; const name = ctx.scope - ? `@${ctx.scope}/plugin-${id}` - : `backstage-plugin-${id}`; + ? `@${ctx.scope}/plugin-${pluginId}` + : `backstage-plugin-${pluginId}`; Task.log(); Task.log(`Creating backend plugin ${chalk.cyan(name)}`); const targetDir = ctx.isMonoRepo - ? paths.resolveTargetRoot('plugins', id) - : paths.resolveTargetRoot(`backstage-plugin-${id}`); + ? paths.resolveTargetRoot('plugins', pluginId) + : paths.resolveTargetRoot(`backstage-plugin-${pluginId}`); await executePluginPackageTemplate(ctx, { targetDir, From 2b435be4cf730299232a5230d69e82b985d54754 Mon Sep 17 00:00:00 2001 From: Aramis Sennyey Date: Fri, 13 Jan 2023 15:30:30 -0500 Subject: [PATCH 3/4] Add changeset. Signed-off-by: Aramis Sennyey --- .changeset/few-mails-help.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/few-mails-help.md diff --git a/.changeset/few-mails-help.md b/.changeset/few-mails-help.md new file mode 100644 index 0000000000..221481c596 --- /dev/null +++ b/.changeset/few-mails-help.md @@ -0,0 +1,5 @@ +--- +'@backstage/cli': patch +--- + +Updated backend plugin ID during creation to match user-entered input. From e2137426742956094a662524508fd6ed8502ea9c Mon Sep 17 00:00:00 2001 From: Aramis Sennyey Date: Fri, 13 Jan 2023 15:31:24 -0500 Subject: [PATCH 4/4] Revert documentation change. Signed-off-by: Aramis Sennyey --- docs/plugins/backend-plugin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/backend-plugin.md b/docs/plugins/backend-plugin.md index b9141236b5..517779d161 100644 --- a/docs/plugins/backend-plugin.md +++ b/docs/plugins/backend-plugin.md @@ -48,7 +48,7 @@ This will think for a bit, and then say `Listening on :7007`. In a different terminal window, now run ```sh -curl localhost:7007/carmen-backend/health +curl localhost:7007/carmen/health ``` This should return `{"status":"ok"}`. Success! Press `Ctrl + c` to stop it