From b269da39ac2d02841abcb391d59d2d692cebf87d Mon Sep 17 00:00:00 2001 From: Simone Fumagalli Date: Wed, 17 May 2023 15:27:28 +0200 Subject: [PATCH 1/2] DX: Improved error message for publish:gitlab:merge-request action Signed-off-by: Simone Fumagalli --- .changeset/light-cows-bow.md | 5 +++++ .../actions/builtin/publish/gitlabMergeRequest.ts | 6 ++++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 .changeset/light-cows-bow.md diff --git a/.changeset/light-cows-bow.md b/.changeset/light-cows-bow.md new file mode 100644 index 0000000000..231a4245c3 --- /dev/null +++ b/.changeset/light-cows-bow.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder-backend': minor +--- + +Clearer error messages for action publish:gitlab:merge-request diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts index 06e056cda3..84a17024d1 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts @@ -218,14 +218,16 @@ export const createPublishGitlabMergeRequestAction = (options: { try { await api.Branches.create(repoID, branchName, String(defaultBranch)); } catch (e) { - throw new InputError(`The branch creation failed ${e}`); + throw new InputError( + `The branch creation failed. Please check that your repo does not already contain a branch named '${branchName}'. ${e}`, + ); } try { await api.Commits.create(repoID, branchName, ctx.input.title, actions); } catch (e) { throw new InputError( - `Committing the changes to ${branchName} failed ${e}`, + `Committing the changes to ${branchName} failed. Please check that none of the files created by the template already exists. ${e}`, ); } From 2b9075a4f3016c920799ddd6cc6541e9446cd6f7 Mon Sep 17 00:00:00 2001 From: Ben Lambert Date: Mon, 22 May 2023 12:42:48 +0200 Subject: [PATCH 2/2] Update light-cows-bow.md Signed-off-by: Ben Lambert --- .changeset/light-cows-bow.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/light-cows-bow.md b/.changeset/light-cows-bow.md index 231a4245c3..ba1b1c7631 100644 --- a/.changeset/light-cows-bow.md +++ b/.changeset/light-cows-bow.md @@ -1,5 +1,5 @@ --- -'@backstage/plugin-scaffolder-backend': minor +'@backstage/plugin-scaffolder-backend': patch --- -Clearer error messages for action publish:gitlab:merge-request +Clearer error messages for action `publish:gitlab:merge-request`