redocly-cli
ActionsTags
(1)This action lets you use the redocly cli to generate an HTML version of your OpenAPI documents.
The arguments to be provided to the redocly command.
By default, this is empty so that redocly will print a note about its correct usage.
No outputs are returned.
The redocly command will automatically save the output into a file called redoc-static.html.
It's created in the root folder of the repository's workspace.
See main.yml for a "real-life" example and redocly cli for all available options.
jobs:
test_job:
runs-on: ubuntu-latest
name: Test
steps:
# first checkout your code
- name: Checkout
uses: actions/checkout@v4
# then use redoc-cli-github-action to generate your HTML bundle
- name: redoc-cli test
uses: DeltaLaboratory/redocly-cli-action@v1.0.0
with:
args: 'build-docs test/petstore.yml'The example is using the bundle command by providing the OpenAPI document test/petstore.yml.
This file must be present within your repository's workspace.
Alternatively, you can point it to a file under a certain URL.
- name: redoc-cli test
uses: DeltaLaboratory/redocly-cli-action@v1.0.0
with:
args: 'build-docs https://petstore.swagger.io/v2/swagger.yaml'If you need to specify a custom name and destination for the output file, use the -o option like this:
- name: redoc-cli test
uses: DeltaLaboratory/redocly-cli-action@v1.0.0
with:
args: 'build-docs test/petstore.yml -o petstore.html'redocly-cli is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.