paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 20 Packages Projects Releases Wiki Activity

Merge pull request #23918 from BillyMichael/chore/improve-git-example-consistency

Browse Source 
Improve cosnsitency of git publish actions examples
This commit is contained in:
Fredrik Adelöw
2024-04-09 09:24:41 +02:00
committed by GitHub
parent 2ca9dc00b2 06c25ed58f
commit 5cd801ab2a
8 changed files with 73 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/silent-sloths-repair.md
+10
View File
@@ -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
plugins/scaffolder-backend-module-azure/src/actions/azure.examples.ts
+4 -4
View File
@@ -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 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: 'Add a description.',
description: 'Initializes an Azure DevOps repository with a description.',
example: yaml.stringify({
steps: [
{
@@ -53,7 +53,8 @@ export const examples: TemplateExample[] = [
}),
},
{
description: 'Change the default branch.',
description:
'Initializes an Azure DevOps 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',
},
},
plugins/scaffolder-backend-module-bitbucket-cloud/src/actions/bitbucketCloud.examples.ts
+1 -1
View File
@@ -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 with the content in the workspace, and publishes it to Bitbucket Cloud with the default configuration.',
example: yaml.stringify({
steps: [
{
plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.test.ts
+14 -11
View File
@@ -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' },
});
});
plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.examples.ts
+33 -26
View File
@@ -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 with the content in the workspace, and publishes it to Bitbucket with the default configuration.',
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: [
{
plugins/scaffolder-backend-module-gitea/src/actions/gitea.examples.ts
+2 -2
View File
@@ -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 with the content in the workspace, and publishes it to Gitea with the default configuration.',
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: [
{
plugins/scaffolder-backend-module-github/src/actions/github.examples.ts
+4 -4
View File
@@ -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 with the content in the workspace, and publishes it to GitHub with the default configuration.',
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',
},
},
plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.examples.ts
+5 -5
View File
@@ -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 with the content in the workspace, and publishes it to GitLab with the default configuration.',
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: [
{