diff --git a/action.yml b/action.yml index 5366e43d079..4cdfbfa5412 100644 --- a/action.yml +++ b/action.yml @@ -1,7 +1,7 @@ name: 'Generator, Validator, Converter and others - all in one for your AsyncAPI docs' description: 'Use this action to generate docs or code from your AsyncAPI document. Use default templates or provide your custom ones.' inputs: - cli_version: + cli_version: description: 'Version of AsyncAPI CLI to be used. This is only needed if you want to test with a specific version of AsyncAPI CLI. Default is latest which is also the recommended option.' required: false default: '' @@ -13,7 +13,7 @@ inputs: description: 'Path to AsyncAPI document. This input is required if command is set to generate, validate, convert or optimize. Default is ./asyncapi.yaml' required: false default: 'asyncapi.yml' - template: + template: description: 'Template for the generator. Official templates are listed here https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate. You can pass template as npm package, url to git repository, link to tar file or local template.' default: '@asyncapi/markdown-template@0.10.0' required: false @@ -25,7 +25,7 @@ inputs: description: 'Directory where to put the generated files. Can be used only with generate or convert commands. Default is output.' required: false default: 'output' - parameters: + parameters: description: 'The command that you use might support and even require specific parameters to be passed to the CLI for the generation. Template parameters should be preceded by -p' required: false default: '' @@ -33,12 +33,12 @@ inputs: description: 'Custom command to be run. This input is required if command is set to custom.' required: false default: '' - + runs: using: 'docker' - # This is the image that will be used to run the action. + # This is the image that will be used to run the action. # IMPORTANT: The version has to be changed manually in your PRs. - image: 'docker://asyncapi/github-action-for-cli:3.1.2' + image: 'docker://asyncapi/github-action-for-cli:2.8.1' args: - ${{ inputs.cli_version }} - ${{ inputs.command }}