From 8a7d4444e3ee1473722d2aff82f62a56b020b282 Mon Sep 17 00:00:00 2001 From: Shivam bisht Date: Tue, 1 Mar 2022 02:14:23 +0530 Subject: [PATCH 1/7] Added default commit message Signed-off-by: Shivam bisht --- .../actions/builtin/publish/gitlab.ts | 37 +++++++++++++++---- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts index 9aa12803eb..c72ee9a665 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts @@ -40,6 +40,9 @@ export function createPublishGitlabAction(options: { repoVisibility?: 'private' | 'internal' | 'public'; sourcePath?: string; token?: string; + defaultCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }>({ id: 'publish:gitlab', description: @@ -63,6 +66,21 @@ export function createPublishGitlabAction(options: { type: 'string', description: `Sets the default branch on the repository. The default value is 'master'`, }, + defaultCommitMessage: { + title: 'Default Commit Message', + type: 'string', + description: `Sets the default commit message on the repository. The default value is 'initial commit'`, + }, + gitAuthorName: { + title: 'Default Author Name', + type: 'string', + description: `Sets the default author name for the commit. The default value is 'Scaffolder'`, + }, + gitAuthorEmail: { + title: 'Default Author Email', + type: 'string', + description: `Sets the default author email for the commit.`, + }, sourcePath: { title: 'Source Path', description: @@ -95,8 +113,10 @@ export function createPublishGitlabAction(options: { repoUrl, repoVisibility = 'private', defaultBranch = 'master', + defaultCommitMessage = 'initial commit', + gitAuthorName, + gitAuthorEmail, } = ctx.input; - const { owner, repo, host } = parseRepoUrl(repoUrl, integrations); if (!owner) { @@ -146,10 +166,13 @@ export function createPublishGitlabAction(options: { const repoContentsUrl = `${remoteUrl}/-/blob/${defaultBranch}`; const gitAuthorInfo = { - name: config.getOptionalString('scaffolder.defaultAuthor.name'), - email: config.getOptionalString('scaffolder.defaultAuthor.email'), + name: gitAuthorName + ? gitAuthorName + : config.getOptionalString('scaffolder.defaultAuthor.name'), + email: gitAuthorEmail + ? gitAuthorEmail + : config.getOptionalString('scaffolder.defaultAuthor.email'), }; - await initRepoAndPush({ dir: getRepoSourceDirectory(ctx.workspacePath, ctx.input.sourcePath), remoteUrl: http_url_to_repo as string, @@ -159,9 +182,9 @@ export function createPublishGitlabAction(options: { password: token, }, logger: ctx.logger, - commitMessage: config.getOptionalString( - 'scaffolder.defaultCommitMessage', - ), + commitMessage: defaultCommitMessage + ? defaultCommitMessage + : config.getOptionalString('scaffolder.defaultCommitMessage'), gitAuthorInfo, }); From 2a7d52ca2cea14c43c929d93383a4e51a84be00f Mon Sep 17 00:00:00 2001 From: Shivam bisht Date: Tue, 1 Mar 2022 02:50:16 +0530 Subject: [PATCH 2/7] Added changeset Signed-off-by: Shivam bisht --- .changeset/angry-pens-begin.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/angry-pens-begin.md diff --git a/.changeset/angry-pens-begin.md b/.changeset/angry-pens-begin.md new file mode 100644 index 0000000000..620baa8079 --- /dev/null +++ b/.changeset/angry-pens-begin.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder-backend': patch +--- + +override default commit message and author details in gitlab action From 44766e8f676e2e9185eae2a870db8de00c57125d Mon Sep 17 00:00:00 2001 From: mufaddal motiwala Date: Fri, 4 Mar 2022 17:24:46 +0530 Subject: [PATCH 3/7] md fix Signed-off-by: mufaddal motiwala Signed-off-by: Shivam bisht --- .changeset/angry-pens-begin.md | 2 +- plugins/scaffolder-backend/api-report.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.changeset/angry-pens-begin.md b/.changeset/angry-pens-begin.md index 620baa8079..b8d6f80292 100644 --- a/.changeset/angry-pens-begin.md +++ b/.changeset/angry-pens-begin.md @@ -2,4 +2,4 @@ '@backstage/plugin-scaffolder-backend': patch --- -override default commit message and author details in gitlab action +Override default commit message and author details in GitLab action diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index d454fe2e7b..7cb29fcf60 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -266,6 +266,9 @@ export function createPublishGitlabAction(options: { repoVisibility?: 'internal' | 'private' | 'public' | undefined; sourcePath?: string | undefined; token?: string | undefined; + defaultCommitMessage?: string | undefined; + gitAuthorName?: string | undefined; + gitAuthorEmail?: string | undefined; }>; // @public From 87b30f4efbc7ebb14f3b562e8679777beba5ede2 Mon Sep 17 00:00:00 2001 From: Shivam bisht Date: Thu, 10 Mar 2022 13:22:04 +0530 Subject: [PATCH 4/7] added commitMessage to test file Signed-off-by: Shivam bisht --- .../src/scaffolder/actions/builtin/publish/gitlab.test.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts index ed8df4e5e8..66780e3184 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts @@ -181,6 +181,7 @@ describe('publish:gitlab', () => { remoteUrl: 'http://mockurl.git', auth: { username: 'oauth2', password: 'tokenlols' }, logger: mockContext.logger, + commitMessage: 'initial commit', gitAuthorInfo: {}, }); }); @@ -205,6 +206,7 @@ describe('publish:gitlab', () => { remoteUrl: 'http://mockurl.git', auth: { username: 'oauth2', password: 'tokenlols' }, logger: mockContext.logger, + commitMessage: 'initial commit', gitAuthorInfo: {}, }); }); @@ -252,6 +254,7 @@ describe('publish:gitlab', () => { auth: { username: 'oauth2', password: 'tokenlols' }, logger: mockContext.logger, defaultBranch: 'master', + commitMessage: 'Test commit message', gitAuthorInfo: { name: 'Test', email: 'example@example.com' }, }); }); @@ -294,10 +297,10 @@ describe('publish:gitlab', () => { dir: mockContext.workspacePath, remoteUrl: 'http://mockurl.git', auth: { username: 'oauth2', password: 'tokenlols' }, - logger: mockContext.logger, defaultBranch: 'master', commitMessage: 'Test commit message', gitAuthorInfo: { email: undefined, name: undefined }, + logger: mockContext.logger, }); }); From caa98d4d9e9dfd559d2332311505102a3ca9c5fe Mon Sep 17 00:00:00 2001 From: Shivam bisht Date: Wed, 16 Mar 2022 20:21:26 +0530 Subject: [PATCH 5/7] modified defaultCommitMessage Signed-off-by: Shivam bisht --- .../src/scaffolder/actions/builtin/publish/gitlab.test.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts index 66780e3184..f427023c69 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.test.ts @@ -254,7 +254,7 @@ describe('publish:gitlab', () => { auth: { username: 'oauth2', password: 'tokenlols' }, logger: mockContext.logger, defaultBranch: 'master', - commitMessage: 'Test commit message', + commitMessage: 'initial commit', gitAuthorInfo: { name: 'Test', email: 'example@example.com' }, }); }); @@ -298,7 +298,7 @@ describe('publish:gitlab', () => { remoteUrl: 'http://mockurl.git', auth: { username: 'oauth2', password: 'tokenlols' }, defaultBranch: 'master', - commitMessage: 'Test commit message', + commitMessage: 'initial commit', gitAuthorInfo: { email: undefined, name: undefined }, logger: mockContext.logger, }); From 1e128d9531e1ee9fe4b59387fa1f5cdba807eed2 Mon Sep 17 00:00:00 2001 From: Shivam bisht Date: Tue, 22 Mar 2022 13:52:39 +0530 Subject: [PATCH 6/7] changed gitCommitMessage from defaultCommitMessage Signed-off-by: Shivam bisht --- .../scaffolder/actions/builtin/publish/gitlab.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts index c72ee9a665..a7c247f4d9 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlab.ts @@ -40,7 +40,7 @@ export function createPublishGitlabAction(options: { repoVisibility?: 'private' | 'internal' | 'public'; sourcePath?: string; token?: string; - defaultCommitMessage?: string; + gitCommitMessage?: string; gitAuthorName?: string; gitAuthorEmail?: string; }>({ @@ -66,10 +66,10 @@ export function createPublishGitlabAction(options: { type: 'string', description: `Sets the default branch on the repository. The default value is 'master'`, }, - defaultCommitMessage: { - title: 'Default Commit Message', + gitCommitMessage: { + title: 'Git Commit Message', type: 'string', - description: `Sets the default commit message on the repository. The default value is 'initial commit'`, + description: `Sets the commit message on the repository. The default value is 'initial commit'`, }, gitAuthorName: { title: 'Default Author Name', @@ -113,7 +113,7 @@ export function createPublishGitlabAction(options: { repoUrl, repoVisibility = 'private', defaultBranch = 'master', - defaultCommitMessage = 'initial commit', + gitCommitMessage = 'initial commit', gitAuthorName, gitAuthorEmail, } = ctx.input; @@ -182,8 +182,8 @@ export function createPublishGitlabAction(options: { password: token, }, logger: ctx.logger, - commitMessage: defaultCommitMessage - ? defaultCommitMessage + commitMessage: gitCommitMessage + ? gitCommitMessage : config.getOptionalString('scaffolder.defaultCommitMessage'), gitAuthorInfo, }); From 45b4b821a00730cce0835b065225c0470074b6b6 Mon Sep 17 00:00:00 2001 From: Shivam bisht Date: Tue, 22 Mar 2022 17:59:28 +0530 Subject: [PATCH 7/7] updated api reports Signed-off-by: Shivam bisht --- plugins/scaffolder-backend/api-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index 7cb29fcf60..89ca6b55bd 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -266,7 +266,7 @@ export function createPublishGitlabAction(options: { repoVisibility?: 'internal' | 'private' | 'public' | undefined; sourcePath?: string | undefined; token?: string | undefined; - defaultCommitMessage?: string | undefined; + gitCommitMessage?: string | undefined; gitAuthorName?: string | undefined; gitAuthorEmail?: string | undefined; }>;