From bc42275038d55066ebbd93334096fb9dab306a67 Mon Sep 17 00:00:00 2001 From: Juan Escalada Date: Wed, 4 Dec 2024 11:37:53 +0900 Subject: [PATCH 1/7] Add github backend module and doc links to errors Signed-off-by: Juan Escalada --- .../templates/default-app/packages/backend/src/index.ts | 1 + plugins/scaffolder-backend-module-github/src/actions/helpers.ts | 2 +- .../src/scaffolder/actions/TemplateActionRegistry.ts | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/create-app/templates/default-app/packages/backend/src/index.ts b/packages/create-app/templates/default-app/packages/backend/src/index.ts index 69a73511c6..6d0a6f4ca5 100644 --- a/packages/create-app/templates/default-app/packages/backend/src/index.ts +++ b/packages/create-app/templates/default-app/packages/backend/src/index.ts @@ -13,6 +13,7 @@ const backend = createBackend(); backend.add(import('@backstage/plugin-app-backend')); backend.add(import('@backstage/plugin-proxy-backend')); backend.add(import('@backstage/plugin-scaffolder-backend')); +backend.add(import('@backstage/plugin-scaffolder-backend-module-github')); backend.add(import('@backstage/plugin-techdocs-backend')); // auth plugin diff --git a/plugins/scaffolder-backend-module-github/src/actions/helpers.ts b/plugins/scaffolder-backend-module-github/src/actions/helpers.ts index 0ae1cad3fb..b28c35105c 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/helpers.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/helpers.ts @@ -93,7 +93,7 @@ export async function getOctokitOptions(options: { if (!credentialProviderToken) { throw new InputError( - `No token available for host: ${host}, with owner ${owner}, and repo ${repo}`, + `No token available for host: ${host}, with owner ${owner}, and repo ${repo}. Make sure GitHub auth is configured correctly. See https://backstage.io/docs/auth/github/provider for more details.`, ); } diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts b/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts index 3868380919..f00d7afad1 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts @@ -37,7 +37,7 @@ export class TemplateActionRegistry { const action = this.actions.get(actionId); if (!action) { throw new NotFoundError( - `Template action with ID '${actionId}' is not registered.`, + `Template action with ID '${actionId}' is not registered. See https://backstage.io/docs/features/software-templates/builtin-actions/ on how to add a new action module.`, ); } return action; From 60ae194e832878d177d667d48af726ab1d9efe1d Mon Sep 17 00:00:00 2001 From: Juan Escalada Date: Wed, 4 Dec 2024 11:51:08 +0900 Subject: [PATCH 2/7] Fix error message matching Signed-off-by: Juan Escalada --- .../src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts index 9bef42b26a..3990ac14b6 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts @@ -208,7 +208,7 @@ describe('NunjucksWorkflowRunner', () => { }); await expect(runner.execute(task)).rejects.toThrow( - "Template action with ID 'does-not-exist' is not registered.", + /Template action with ID 'does-not-exist' is not registered/, ); }); From e913fdf40259987a7d56ccbe499a982d7968f248 Mon Sep 17 00:00:00 2001 From: Juan Escalada Date: Wed, 4 Dec 2024 11:54:52 +0900 Subject: [PATCH 3/7] Add changeset Signed-off-by: Juan Escalada --- .changeset/lucky-crabs-vanish.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .changeset/lucky-crabs-vanish.md diff --git a/.changeset/lucky-crabs-vanish.md b/.changeset/lucky-crabs-vanish.md new file mode 100644 index 0000000000..99e9e20599 --- /dev/null +++ b/.changeset/lucky-crabs-vanish.md @@ -0,0 +1,7 @@ +--- +'@backstage/plugin-scaffolder-backend-module-github': minor +'@backstage/plugin-scaffolder-backend': minor +'@backstage/create-app': minor +--- + +Add github backend module to create-app and improve error messages From 4e83ddbd9a3384e1b42af987464fd040892a9cec Mon Sep 17 00:00:00 2001 From: Juan Escalada Date: Wed, 4 Dec 2024 12:48:46 +0900 Subject: [PATCH 4/7] Add missing github module to hbs template Signed-off-by: Juan Escalada --- .../templates/default-app/packages/backend/package.json.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/create-app/templates/default-app/packages/backend/package.json.hbs b/packages/create-app/templates/default-app/packages/backend/package.json.hbs index bb05beddaa..42afefd3b8 100644 --- a/packages/create-app/templates/default-app/packages/backend/package.json.hbs +++ b/packages/create-app/templates/default-app/packages/backend/package.json.hbs @@ -33,6 +33,7 @@ "@backstage/plugin-permission-node": "^{{version '@backstage/plugin-permission-node'}}", "@backstage/plugin-proxy-backend": "^{{version '@backstage/plugin-proxy-backend'}}", "@backstage/plugin-scaffolder-backend": "^{{version '@backstage/plugin-scaffolder-backend'}}", + "@backstage/plugin-scaffolder-backend-module-github": "^{{version '@backstage/plugin-scaffolder-backend-module-github'}}", "@backstage/plugin-search-backend": "^{{version '@backstage/plugin-search-backend'}}", "@backstage/plugin-search-backend-module-catalog": "^{{version '@backstage/plugin-search-backend-module-catalog'}}", "@backstage/plugin-search-backend-module-pg": "^{{version '@backstage/plugin-search-backend-module-pg'}}", From 2e16294914b14b698baf39f8ecd4f74ec10fbe4b Mon Sep 17 00:00:00 2001 From: Juan Escalada Date: Wed, 4 Dec 2024 13:42:23 +0900 Subject: [PATCH 5/7] Add missing module to versions.ts Signed-off-by: Juan Escalada --- packages/create-app/src/lib/versions.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/create-app/src/lib/versions.ts b/packages/create-app/src/lib/versions.ts index 9a7158ea55..d06912cca3 100644 --- a/packages/create-app/src/lib/versions.ts +++ b/packages/create-app/src/lib/versions.ts @@ -72,6 +72,7 @@ import { version as pluginPermissionNode } from '../../../../plugins/permission- import { version as pluginProxyBackend } from '../../../../plugins/proxy-backend/package.json'; import { version as pluginScaffolder } from '../../../../plugins/scaffolder/package.json'; import { version as pluginScaffolderBackend } from '../../../../plugins/scaffolder-backend/package.json'; +import { version as pluginScaffolderBackendModuleGithub } from '../../../../plugins/scaffolder-backend-module-github/package.json'; import { version as pluginSearch } from '../../../../plugins/search/package.json'; import { version as pluginSearchReact } from '../../../../plugins/search-react/package.json'; import { version as pluginSearchBackend } from '../../../../plugins/search-backend/package.json'; @@ -130,6 +131,8 @@ export const packageVersions = { '@backstage/plugin-proxy-backend': pluginProxyBackend, '@backstage/plugin-scaffolder': pluginScaffolder, '@backstage/plugin-scaffolder-backend': pluginScaffolderBackend, + '@backstage/plugin-scaffolder-backend-module-github': + pluginScaffolderBackendModuleGithub, '@backstage/plugin-search': pluginSearch, '@backstage/plugin-search-react': pluginSearchReact, '@backstage/plugin-search-backend': pluginSearchBackend, From 43533b353613e8d0d5f3e9fc16e3feb687862515 Mon Sep 17 00:00:00 2001 From: Juan Escalada Date: Wed, 4 Dec 2024 14:32:05 +0900 Subject: [PATCH 6/7] Add missing module to mock Signed-off-by: Juan Escalada --- packages/create-app/src/lib/tasks.test.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/create-app/src/lib/tasks.test.ts b/packages/create-app/src/lib/tasks.test.ts index 27c5765a12..3d5240977e 100644 --- a/packages/create-app/src/lib/tasks.test.ts +++ b/packages/create-app/src/lib/tasks.test.ts @@ -91,6 +91,7 @@ jest.mock('./versions', () => ({ '@backstage/plugin-kubernetes-backend': '1.0.0', '@backstage/plugin-org': '1.0.0', '@backstage/plugin-scaffolder': '1.0.0', + '@backstage/plugin-scaffolder-backend-module-github': '1.0.0', '@backstage/plugin-permission-react': '1.0.0', '@backstage/plugin-search': '1.0.0', '@backstage/plugin-search-react': '1.0.0', From ede78de3b0b7772c85c3842bc9b90e194ae1e94a Mon Sep 17 00:00:00 2001 From: Juan Escalada <97265671+jescalada@users.noreply.github.com> Date: Wed, 4 Dec 2024 02:37:08 -0800 Subject: [PATCH 7/7] Update .changeset/lucky-crabs-vanish.md Co-authored-by: Ben Lambert Signed-off-by: Juan Escalada <97265671+jescalada@users.noreply.github.com> --- .changeset/lucky-crabs-vanish.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.changeset/lucky-crabs-vanish.md b/.changeset/lucky-crabs-vanish.md index 99e9e20599..158200fb7e 100644 --- a/.changeset/lucky-crabs-vanish.md +++ b/.changeset/lucky-crabs-vanish.md @@ -1,7 +1,7 @@ --- -'@backstage/plugin-scaffolder-backend-module-github': minor -'@backstage/plugin-scaffolder-backend': minor -'@backstage/create-app': minor +'@backstage/plugin-scaffolder-backend-module-github': patch +'@backstage/plugin-scaffolder-backend': patch +'@backstage/create-app': patch --- Add github backend module to create-app and improve error messages