|
1 | | -name: 'Bump.sh' |
2 | | -description: 'Keep your public, private and partner API docs in sync with your code, whether you use OpenAPI or AsyncAPI.' |
| 1 | +name: "Bump.sh API Documentation & Changelog" |
| 2 | +description: | |
| 3 | + Keep your public, private and partner API docs in sync with your code, whether you use OpenAPI or AsyncAPI. |
3 | 4 | inputs: |
4 | 5 | file: |
5 | | - description: 'Relative path to the documentation file' |
| 6 | + description: "Relative path to an API definition file (OpenAPI or AsyncAPI)" |
6 | 7 | required: true |
7 | 8 | default: api-contract.yml |
8 | 9 | doc: |
9 | | - description: 'Documentation id. Can be found in the documentation settings on https://bump.sh' |
| 10 | + description: "Documentation slug or id. Can be found in the documentation settings on https://bump.sh" |
10 | 11 | token: |
11 | | - description: 'Documentation token. Can be found in the documentation settings on https://bump.sh' |
| 12 | + description: "Api token. Can be found in the documentation or organization settings on https://bump.sh" |
12 | 13 | hub: |
13 | | - description: 'Hub slug or id. Needed when deploying to a documentation attached to a Hub. Can be found in the hub settings on https://bump.sh' |
| 14 | + description: "Hub slug or id. Needed when deploying to a documentation attached to a Hub. Can be found in the hub settings on https://bump.sh" |
14 | 15 | branch: |
15 | | - description: 'Branch name used during `deploy` or `diff` commands. This can be useful to maintain multiple API reference history and make it available in your API documentation.' |
| 16 | + description: "Branch name used during `deploy` or `diff` commands. This can be useful to maintain multiple API reference history and make it available in your API documentation." |
16 | 17 | command: |
17 | | - description: 'Bump command: deploy|dry-run|preview|diff' |
| 18 | + description: "Bump command: deploy|dry-run|preview|diff" |
18 | 19 | default: deploy |
19 | 20 | expires: |
20 | | - description: 'Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `never` to keep the result live indefinitely.' |
| 21 | + description: "Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `never` to keep the result live indefinitely." |
21 | 22 | fail_on_breaking: |
22 | | - description: 'Mark the action as failed when a breaking change is detected with the diff command. This is only valid when `diff` is provided in the command input.' |
| 23 | + description: "Mark the action as failed when a breaking change is detected with the diff command. This is only valid when `diff` is provided in the command input." |
23 | 24 | default: false |
24 | 25 | runs: |
25 | | - using: 'node16' |
26 | | - main: 'dist/index.js' |
| 26 | + using: "node16" |
| 27 | + main: "dist/index.js" |
27 | 28 | branding: |
28 | 29 | color: gray-dark |
29 | 30 | icon: book-open |
0 commit comments