From 24f3c907c65a8f7698b8e4c8d740847c59d0c464 Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 15:13:46 +0100 Subject: [PATCH 1/4] chore: fix failing bitbucket example tests Signed-off-by: Billy Michael --- .../src/actions/bitbucket.examples.test.ts | 25 +++++++++++-------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.test.ts b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.test.ts index c8f35fa0bf..6633246d70 100644 --- a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.test.ts +++ b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.test.ts @@ -110,7 +110,7 @@ describe('publish:bitbucket', () => { auth: { username: 'x-token-auth', password: 'tokenlols' }, logger: mockContext.logger, commitMessage: 'initial commit', - gitAuthorInfo: {}, + gitAuthorInfo: { email: undefined, name: undefined }, }); }); @@ -151,7 +151,7 @@ describe('publish:bitbucket', () => { auth: { username: 'x-token-auth', password: 'tokenlols' }, logger: mockContext.logger, commitMessage: 'initial commit', - gitAuthorInfo: {}, + gitAuthorInfo: { email: undefined, name: undefined }, }); }); @@ -189,9 +189,9 @@ describe('publish:bitbucket', () => { remoteUrl: 'https://bitbucket.org/workspace/cloneurl', auth: { username: 'x-token-auth', password: 'tokenlols' }, logger: mockContext.logger, - defaultBranch: 'main', + defaultBranch: 'master', commitMessage: 'initial commit', - gitAuthorInfo: {}, + gitAuthorInfo: { email: undefined, name: undefined }, }); }); @@ -229,9 +229,12 @@ describe('publish:bitbucket', () => { remoteUrl: 'https://bitbucket.org/workspace/cloneurl', auth: { username: 'x-token-auth', password: 'your-auth-token' }, logger: mockContext.logger, - defaultBranch: 'main', + defaultBranch: 'master', commitMessage: 'initial commit', - gitAuthorInfo: {}, + gitAuthorInfo: { + email: undefined, + name: undefined, + }, }); }); @@ -268,9 +271,9 @@ describe('publish:bitbucket', () => { expect(initRepoAndPush).toHaveBeenCalledWith({ dir: mockContext.workspacePath, remoteUrl: 'https://bitbucket.org/workspace/cloneurl', - auth: { username: 'x-token-auth', password: 'your-auth-token' }, + auth: { username: 'x-token-auth', password: 'tokenlols' }, logger: mockContext.logger, - defaultBranch: 'main', + defaultBranch: 'master', commitMessage: 'Initial commit with custom message', gitAuthorInfo: { email: undefined, name: undefined }, }); @@ -309,10 +312,10 @@ describe('publish:bitbucket', () => { expect(initRepoAndPush).toHaveBeenCalledWith({ dir: mockContext.workspacePath, remoteUrl: 'https://bitbucket.org/workspace/cloneurl', - auth: { username: 'x-token-auth', password: 'your-auth-token' }, + auth: { username: 'x-token-auth', password: 'tokenlols' }, logger: mockContext.logger, - defaultBranch: 'main', - commitMessage: 'Initial commit with custom message', + defaultBranch: 'master', + commitMessage: 'initial commit', gitAuthorInfo: { email: 'your.email@example.com', name: 'Your Name' }, }); }); From 55bffb2ab1043e4037bf06543773c0fc809520b3 Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 16:21:48 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Billy Michael --- .../src/actions/azure.examples.ts | 4 ++-- .../src/actions/bitbucketCloud.examples.ts | 2 +- .../src/actions/bitbucket.examples.ts | 2 +- .../src/actions/gitea.examples.ts | 2 +- .../src/actions/github.examples.ts | 2 +- .../src/actions/gitlab.examples.ts | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts b/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts index 97f272d1e7..d8bd74a369 100644 --- a/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts +++ b/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts @@ -20,7 +20,7 @@ import yaml from 'yaml'; export const examples: TemplateExample[] = [ { description: - 'Initializes a git repository of the content in the workspace, and publishes it to Azure with the default confiiguration.', + 'Initializes a git repository with the content in the workspace, and publishes it to Azure DevOps with the default configuration.', example: yaml.stringify({ steps: [ { @@ -36,7 +36,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes an Azure repository with a description.', + description: 'Initializes an Azure DevOps repository with a description.', example: yaml.stringify({ steps: [ { diff --git a/plugins/scaffolder-backend-module-bitbucket-cloud/src/actions/bitbucketCloud.examples.ts b/plugins/scaffolder-backend-module-bitbucket-cloud/src/actions/bitbucketCloud.examples.ts index ab61a32eec..63e4ccb212 100644 --- a/plugins/scaffolder-backend-module-bitbucket-cloud/src/actions/bitbucketCloud.examples.ts +++ b/plugins/scaffolder-backend-module-bitbucket-cloud/src/actions/bitbucketCloud.examples.ts @@ -20,7 +20,7 @@ import yaml from 'yaml'; export const examples: TemplateExample[] = [ { description: - 'Initializes a git repository of the content in the workspace, and publishes it to Bitbucket Cloud with the default confiiguration.', + 'Initializes a git repository with the content in the workspace, and publishes it to Bitbucket Cloud with the default configuration.', example: yaml.stringify({ steps: [ { diff --git a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts index 061718fb8c..fe1a6f105b 100644 --- a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts +++ b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts @@ -20,7 +20,7 @@ import yaml from 'yaml'; export const examples: TemplateExample[] = [ { description: - 'Initializes a git repository of the content in the workspace, and publishes it to Bitbucket with the default confiiguration.', + 'Initializes a git repository with the content in the workspace, and publishes it to Bitbucket with the default configuration.', example: yaml.stringify({ steps: [ { diff --git a/plugins/scaffolder-backend-module-gitea/src/actions/gitea.examples.ts b/plugins/scaffolder-backend-module-gitea/src/actions/gitea.examples.ts index 4339de606e..ccf0f4ddf6 100644 --- a/plugins/scaffolder-backend-module-gitea/src/actions/gitea.examples.ts +++ b/plugins/scaffolder-backend-module-gitea/src/actions/gitea.examples.ts @@ -20,7 +20,7 @@ import yaml from 'yaml'; export const examples: TemplateExample[] = [ { description: - 'Initializes a git repository of the content in the workspace, and publishes it to Gitea with the default confiiguration.', + 'Initializes a git repository with the content in the workspace, and publishes it to Gitea with the default configuration.', example: yaml.stringify({ steps: [ { diff --git a/plugins/scaffolder-backend-module-github/src/actions/github.examples.ts b/plugins/scaffolder-backend-module-github/src/actions/github.examples.ts index b558e4904d..baef469c15 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/github.examples.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/github.examples.ts @@ -20,7 +20,7 @@ import yaml from 'yaml'; export const examples: TemplateExample[] = [ { description: - 'Initializes a git repository of the content in the workspace, and publishes it to Github with the default confiiguration.', + 'Initializes a git repository with the content in the workspace, and publishes it to Github with the default configuration.', example: yaml.stringify({ steps: [ { diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.examples.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.examples.ts index f08521b943..e66e37c13a 100644 --- a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.examples.ts +++ b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.examples.ts @@ -20,7 +20,7 @@ import yaml from 'yaml'; export const examples: TemplateExample[] = [ { description: - 'Initializes a git repository of the content in the workspace, and publishes it to Gitlab with the default confiiguration.', + 'Initializes a git repository with the content in the workspace, and publishes it to Gitlab with the default configuration.', example: yaml.stringify({ steps: [ { From 311da7c7dd07111e684928214a966f0b77df45c2 Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 16:23:56 +0100 Subject: [PATCH 3/4] chore: grammar changes based on review feedback Signed-off-by: Billy Michael --- .../src/actions/azure.examples.ts | 2 +- .../src/actions/bitbucket.examples.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts b/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts index d8bd74a369..75cf9742fb 100644 --- a/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts +++ b/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts @@ -54,7 +54,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Initializes a Azure repository with a default Branch, if not set defaults to master', + 'Initializes a Azure repository with a default branch, if not set defaults to master', example: yaml.stringify({ steps: [ { diff --git a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts index fe1a6f105b..12f9472398 100644 --- a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts +++ b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts @@ -72,7 +72,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Initializes a Bitbucket repository with a default Branch, if not set defaults to master', + 'Initializes a Bitbucket repository with a default branch, if not set defaults to master', example: yaml.stringify({ steps: [ { From 3d3c1b12facafba2ef82398c6e649bfedb7ec76c Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 16:27:01 +0100 Subject: [PATCH 4/4] chore: grammar changes based on review feedback Signed-off-by: Billy Michael --- .../src/actions/azure.examples.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts b/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts index 75cf9742fb..d1459d1820 100644 --- a/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts +++ b/plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts @@ -54,7 +54,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Initializes a Azure repository with a default branch, if not set defaults to master', + 'Initializes an Azure DevOps repository with a default branch, if not set defaults to master', example: yaml.stringify({ steps: [ {