Skip to content

Favor name bump.sh #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Polo2 merged 2 commits into from
Dec 12, 2024
Merged

Favor name bump.sh #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
266b9a5
favor Bump.sh in OpenAPI/AsyncAPI examples
Polo2 Dec 9, 2024
b630296
Favor Bump.sh on deployment messages
Polo2 Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/invalid/asyncapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"description": "This is the official Bump API documentation. Obviously created with Bump.\n",
"title": "Bump Api",
"description": "This is the official Bump.sh API documentation. Obviously created with Bump.sh.\n",
"title": "Bump.sh Api",
"version": "1.0"
},
"asyncapi": "2.0.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/invalid/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"description": "This is the official Bump API documentation. Obviously created with Bump.\n",
"title": "Bump Api",
"description": "This is the official Bump.sh API documentation. Obviously created with Bump.sh.\n",
"title": "Bump.sh Api",
"version": "1.0"
},
"openapii": "3.0.2",
Expand Down
8 changes: 4 additions & 4 deletions examples/valid/bump-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"type": "string"
},
"references": {
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump servers, like local files or internal URLs.",
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump.sh servers, like local files or internal URLs.",
"items": {
"$ref": "#/components/schemas/Reference"
},
Expand Down Expand Up @@ -74,7 +74,7 @@
"type": "string"
},
"references": {
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump servers, like local files or internal URLs.",
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump.sh servers, like local files or internal URLs.",
"items": {
"$ref": "#/components/schemas/Reference"
},
Expand Down Expand Up @@ -159,8 +159,8 @@
}
},
"info": {
"description": "This is the official Bump API documentation. Obviously created with Bump.\n",
"title": "Bump Api",
"description": "This is the official Bump.sh API documentation. Obviously created with Bump.sh.\n",
"title": "Bump.sh Api",
"version": "1.0"
},
"openapi": "3.0.2",
Expand Down
8 changes: 4 additions & 4 deletions examples/valid/openapi.v3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"type": "string"
},
"references": {
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump servers, like local files or internal URLs.",
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump.sh servers, like local files or internal URLs.",
"items": {
"$ref": "#/components/schemas/Reference"
},
Expand Down Expand Up @@ -74,7 +74,7 @@
"type": "string"
},
"references": {
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump servers, like local files or internal URLs.",
"description": "Import external references used by `definition`. It's usually resources not accessible by Bump.sh servers, like local files or internal URLs.",
"items": {
"$ref": "#/components/schemas/Reference"
},
Expand Down Expand Up @@ -163,8 +163,8 @@
}
},
"info": {
"description": "This is the official Bump API documentation. Obviously created with Bump.\n",
"title": "Bump Api",
"description": "This is the official Bump.sh API documentation. Obviously created with Bump.sh.\n",
"title": "Bump.sh Api",
"version": "1.0"
},
"openapi": "3.0.2",
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bump-cli",
"description": "The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh",
"description": "The Bump CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh",
"version": "2.9.0-0",
"author": "Paul Bonaud <[email protected]>",
"bin": {
Expand Down
6 changes: 3 additions & 3 deletions src/commands/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@
`Deploy a new version of ${chalk.underline('an existing documentation')}

${chalk.dim('$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>')}
* Let's deploy a new documentation version on Bump... done
* Let's deploy on Bump.sh... done
* Your new documentation version will soon be ready
`,
`Deploy a new version of ${chalk.underline('an existing documentation attached to a hub')}

${chalk.dim('$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>')}
* Let's deploy a new documentation version on Bump... done
* Let's deploy on Bump.sh... done
* Your new documentation version will soon be ready
`,
`Deploy a whole directory of ${chalk.underline('API definitions files to a hub')}
Expand All @@ -49,7 +49,7 @@
`${chalk.underline('Validate a new documentation version')} before deploying it

${chalk.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>')}
* Let's validate a new documentation version on Bump... done
* Let's validate on Bump.sh... done
* Definition is valid
`,
]
Expand All @@ -67,7 +67,7 @@
token: flagsBuilder.token(),
}

protected async deployDirectory(

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 23 - x64 on ubuntu-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 20 - x64 on ubuntu-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node latest - x64 on ubuntu-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 23 - x64 on macos-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 20 - x64 on macos-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node latest - x64 on macos-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 23 - x64 on windows-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node latest - x64 on windows-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4

Check warning on line 70 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 20 - x64 on windows-latest 

Async method 'deployDirectory' has too many parameters (9). Maximum allowed is 4
dir: string,
dryRun: boolean,
token: string,
Expand Down Expand Up @@ -137,7 +137,7 @@
}
}

protected async deploySingleFile(

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 23 - x64 on ubuntu-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 20 - x64 on ubuntu-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node latest - x64 on ubuntu-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 23 - x64 on macos-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 20 - x64 on macos-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node latest - x64 on macos-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 23 - x64 on windows-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node latest - x64 on windows-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4

Check warning on line 140 in src/commands/deploy.ts

View workflow job for this annotation

GitHub Actions / Node 20 - x64 on windows-latest 

Async method 'deploySingleFile' has too many parameters (9). Maximum allowed is 4
api: API,
dryRun: boolean,
documentation: string,
Expand Down
Loading