From 960408e9de50045c9173eda5c5db415c01cb3bb2 Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 14:25:11 +0100 Subject: [PATCH 1/8] chore: improve consistency of all publish action examples Signed-off-by: Billy Michael --- .../src/actions/github.examples.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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 65f2ccdaa3..b558e4904d 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 contents in workspace and publish it to GitHub with default configuration.', + 'Initializes a git repository of the content in the workspace, and publishes it to Github with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -35,7 +35,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Add a description.', + description: 'Initializes a Github repository with a description.', example: yaml.stringify({ steps: [ { @@ -51,7 +51,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Change visibility of the repository.', + description: + 'Initializes a Github repository with public repo visibility, if not set defaults to private', example: yaml.stringify({ steps: [ { @@ -60,7 +61,6 @@ export const examples: TemplateExample[] = [ name: 'Publish to GitHub', input: { repoUrl: 'github.com?repo=repo&owner=owner', - description: 'Initialize a git repository', repoVisibility: 'public', }, }, From c5864b7d5328e2902c997faa876d275d094ec71d Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 14:26:51 +0100 Subject: [PATCH 2/8] chore: improve consistency of all publish action examples Signed-off-by: Billy Michael --- .../src/actions/azure.examples.ts | 8 +-- .../src/actions/bitbucketCloud.examples.ts | 2 +- .../src/actions/bitbucket.examples.ts | 59 +++++++++++-------- .../src/actions/gitea.examples.ts | 4 +- .../src/actions/gitlab.examples.ts | 10 ++-- 5 files changed, 45 insertions(+), 38 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 48b57c410d..97f272d1e7 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.', + 'Initializes a git repository of the content in the workspace, and publishes it to Azure with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -36,7 +36,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Add a description.', + description: 'Initializes an Azure repository with a description.', example: yaml.stringify({ steps: [ { @@ -53,7 +53,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Change the default branch.', + description: + 'Initializes a Azure repository with a default Branch, if not set defaults to master', example: yaml.stringify({ steps: [ { @@ -63,7 +64,6 @@ export const examples: TemplateExample[] = [ input: { repoUrl: 'dev.azure.com?organization=organization&owner=project&repo=repo', - description: 'Initialize a git repository', defaultBranch: 'main', }, }, 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 2d48c99949..ab61a32eec 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 Bitbucket Cloud repository of contents in workspace and publish it to Bitbucket Cloud with default configuration.', + 'Initializes a git repository of the content in the workspace, and publishes it to Bitbucket Cloud with the default confiiguration.', 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 6667afcc9e..061718fb8c 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 contents in workspace and publish it to Bitbucket with default configuration.', + 'Initializes a git repository of the content in the workspace, and publishes it to Bitbucket with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -36,7 +36,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Add a description.', + description: 'Initializes a Bitbucket repository with a description.', example: yaml.stringify({ steps: [ { @@ -53,7 +53,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Change visibility of the repository.', + description: + 'Initializes a Bitbucket repository with public repo visibility, if not set defaults to private', example: yaml.stringify({ steps: [ { @@ -63,7 +64,6 @@ export const examples: TemplateExample[] = [ input: { repoUrl: 'bitbucket.org?repo=repo&workspace=workspace&project=project', - description: 'Initialize a git repository', repoVisibility: 'public', }, }, @@ -71,7 +71,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Set the default branch.', + description: + 'Initializes a Bitbucket repository with a default Branch, if not set defaults to master', example: yaml.stringify({ steps: [ { @@ -81,8 +82,6 @@ export const examples: TemplateExample[] = [ input: { repoUrl: 'bitbucket.org?repo=repo&workspace=workspace&project=project', - description: 'Initialize a git repository', - repoVisibility: 'public', defaultBranch: 'main', }, }, @@ -90,7 +89,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Specify a source path within the workspace.', + description: + 'Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository', example: yaml.stringify({ steps: [ { @@ -100,9 +100,6 @@ export const examples: TemplateExample[] = [ input: { repoUrl: 'bitbucket.org?repo=repo&workspace=workspace&project=project', - description: 'Initialize a git repository', - repoVisibility: 'public', - defaultBranch: 'main', sourcePath: './repoRoot', }, }, @@ -110,7 +107,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Enable LFS for the repository.', + description: 'Initializes a Bitbucket repository with LFS enabled', example: yaml.stringify({ steps: [ { @@ -119,10 +116,6 @@ export const examples: TemplateExample[] = [ name: 'Publish to Bitbucket', input: { repoUrl: 'hosted.bitbucket.com?project=project&repo=repo', - description: 'Initialize a git repository', - repoVisibility: 'public', - defaultBranch: 'main', - sourcePath: './repoRoot', enableLFS: true, }, }, @@ -130,7 +123,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Provide an authentication token for Bitbucket.', + description: + 'Initializes a Bitbucket repository with a custom authentication token', example: yaml.stringify({ steps: [ { @@ -140,9 +134,6 @@ export const examples: TemplateExample[] = [ input: { repoUrl: 'bitbucket.org?repo=repo&workspace=workspace&project=project', - description: 'Initialize a git repository', - repoVisibility: 'public', - defaultBranch: 'main', token: 'your-auth-token', }, }, @@ -150,7 +141,8 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Set a custom commit message.', + description: + 'Initializes a Bitbucket repository with an initial commit message, if not set defaults to `initial commit`', example: yaml.stringify({ steps: [ { @@ -160,10 +152,6 @@ export const examples: TemplateExample[] = [ input: { repoUrl: 'bitbucket.org?repo=repo&workspace=workspace&project=project', - description: 'Initialize a git repository', - repoVisibility: 'public', - defaultBranch: 'main', - token: 'your-auth-token', gitCommitMessage: 'Initial commit with custom message', }, }, @@ -171,7 +159,26 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Set a custom author name and email for the commit.', + description: 'Initializes a Bitbucket repository with a custom author', + example: yaml.stringify({ + steps: [ + { + id: 'publish', + action: 'publish:bitbucket', + name: 'Publish to Bitbucket', + input: { + repoUrl: + 'bitbucket.org?repo=repo&workspace=workspace&project=project', + gitAuthorName: 'Your Name', + gitAuthorEmail: 'your.email@example.com', + }, + }, + ], + }), + }, + { + description: + 'Initializes a Bitbucket repository with all proporties being set', 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 748a869205..4339de606e 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 Gitea repository using the content of the workspace and publish it to Gitea with default configuration.', + 'Initializes a git repository of the content in the workspace, and publishes it to Gitea with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -69,7 +69,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Initializes a Gitea repository with an initial commit message, if not set defaults to initial commit', + 'Initializes a Gitea repository with an initial commit message, if not set defaults to `initial commit`', 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 b20fcf52e9..f08521b943 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.', + 'Initializes a git repository of the content in the workspace, and publishes it to Gitlab with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -52,7 +52,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Sets the commit message on the repository. The default value is `initial commit`.', + 'Initializes a Gitlab repository with an initial commit message, if not set defaults to `initial commit`.', example: yaml.stringify({ steps: [ { @@ -69,7 +69,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a git repository with additional settings.', + description: 'Initializes a Gitlab repository with aditional settings.', example: yaml.stringify({ steps: [ { @@ -88,7 +88,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a git repository with branches settings', + description: 'Initializes a Gitlab repository with branch settings.', example: yaml.stringify({ steps: [ { @@ -115,7 +115,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a git repository with environment variables', + description: 'Initializes a Gitlab repository with environment variables.', example: yaml.stringify({ steps: [ { From 33f958ac2b3a4e6976bbbfbbcef5ab8a0cae6634 Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 14:31:01 +0100 Subject: [PATCH 3/8] chore: add changeset Signed-off-by: Billy Michael --- .changeset/silent-sloths-repair.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .changeset/silent-sloths-repair.md diff --git a/.changeset/silent-sloths-repair.md b/.changeset/silent-sloths-repair.md new file mode 100644 index 0000000000..73ba4196b7 --- /dev/null +++ b/.changeset/silent-sloths-repair.md @@ -0,0 +1,10 @@ +--- +'@backstage/plugin-scaffolder-backend-module-bitbucket-cloud': patch +'@backstage/plugin-scaffolder-backend-module-bitbucket': patch +'@backstage/plugin-scaffolder-backend-module-github': patch +'@backstage/plugin-scaffolder-backend-module-gitlab': patch +'@backstage/plugin-scaffolder-backend-module-azure': patch +'@backstage/plugin-scaffolder-backend-module-gitea': patch +--- + +Improve examples to ensure consistency across all publish actions From 24f3c907c65a8f7698b8e4c8d740847c59d0c464 Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Mon, 1 Apr 2024 15:13:46 +0100 Subject: [PATCH 4/8] 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 5/8] 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 6/8] 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 7/8] 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: [ { From 7f8a5ad5282c03174ffc9440b89546af33fe596b Mon Sep 17 00:00:00 2001 From: Billy Michael Date: Fri, 5 Apr 2024 19:16:31 +0100 Subject: [PATCH 8/8] chore: fix casing of gitlab and github Signed-off-by: Billy Michael --- .../src/actions/github.examples.ts | 6 +++--- .../src/actions/gitlab.examples.ts | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) 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..85dcbeb902 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 of the content in the workspace, and publishes it to GitHub with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -35,7 +35,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a Github repository with a description.', + description: 'Initializes a GitHub repository with a description.', example: yaml.stringify({ steps: [ { @@ -52,7 +52,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Initializes a Github repository with public repo visibility, if not set defaults to private', + 'Initializes a GitHub repository with public repo visibility, if not set defaults to private', 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..2f4de4fc03 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 of the content in the workspace, and publishes it to GitLab with the default confiiguration.', example: yaml.stringify({ steps: [ { @@ -52,7 +52,7 @@ export const examples: TemplateExample[] = [ }, { description: - 'Initializes a Gitlab repository with an initial commit message, if not set defaults to `initial commit`.', + 'Initializes a GitLab repository with an initial commit message, if not set defaults to `initial commit`.', example: yaml.stringify({ steps: [ { @@ -69,7 +69,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a Gitlab repository with aditional settings.', + description: 'Initializes a GitLab repository with aditional settings.', example: yaml.stringify({ steps: [ { @@ -88,7 +88,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a Gitlab repository with branch settings.', + description: 'Initializes a GitLab repository with branch settings.', example: yaml.stringify({ steps: [ { @@ -115,7 +115,7 @@ export const examples: TemplateExample[] = [ }), }, { - description: 'Initializes a Gitlab repository with environment variables.', + description: 'Initializes a GitLab repository with environment variables.', example: yaml.stringify({ steps: [ {