Skip to content

Commit ce67b2e

Browse files
committed
docs: rename the GH action on marketplace
This commit modifes the Action metadata to have a more meaningful name on the GitHub marketplace (currently when searching for “API documentation” on the marketplace doesn't show the Bump.sh action..)
1 parent 060fc2a commit ce67b2e

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

action.yml

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
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.
34
inputs:
45
file:
5-
description: 'Relative path to the documentation file'
6+
description: "Relative path to an API definition file (OpenAPI or AsyncAPI)"
67
required: true
78
default: api-contract.yml
89
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"
1011
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"
1213
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"
1415
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."
1617
command:
17-
description: 'Bump command: deploy|dry-run|preview|diff'
18+
description: "Bump command: deploy|dry-run|preview|diff"
1819
default: deploy
1920
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."
2122
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."
2324
default: false
2425
runs:
25-
using: 'node16'
26-
main: 'dist/index.js'
26+
using: "node16"
27+
main: "dist/index.js"
2728
branding:
2829
color: gray-dark
2930
icon: book-open

0 commit comments

Comments
 (0)