Skip to content

Commit 34bfb03

Browse files
*: changed a bunch of things
1 parent 887111c commit 34bfb03

File tree

5 files changed

+711
-106
lines changed

5 files changed

+711
-106
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 Sebastian Hesse // 2023 DeltaLaboratory
3+
Copyright (c) 2023 DeltaLaboratory
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# redoc-cli-github-action
22

3-
This action lets you use the [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) to generate a HTML version of your OpenAPI documents.
3+
This action lets you use the [redocly cli](https://github.com/Redocly/redocly-cli) to generate an HTML version of your OpenAPI documents.
44

55
## Inputs
66

77
### `args`
88

9-
The arguments to be provided to the `redoc-cli` command.
10-
By default, this is empty so that `redoc-cli` will print a note about its correct usage.
9+
The arguments to be provided to the `redocly` command.
10+
By default, this is empty so that `redocly` will print a note about its correct usage.
1111

1212
## Outputs
1313

1414
No outputs are returned.
15-
The `redoc-cli` command will automatically save the output into a file called `redoc-static.html`.
15+
The `redocly` command will automatically save the output into a file called `redoc-static.html`.
1616
It's created in the root folder of the repository's workspace.
1717

1818
## Example usage
1919

20-
See [main.yml](.github/workflows/main.yml) for a "real-life" example and [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) for all available options.
20+
See [main.yml](.github/workflows/main.yml) for a "real-life" example and [redocly cli](https://github.com/Redocly/redocly-cli) for all available options.
2121

2222
```yaml
2323
jobs:
@@ -32,9 +32,9 @@ jobs:
3232

3333
# then use redoc-cli-github-action to generate your HTML bundle
3434
- name: redoc-cli test
35-
uses: DeltaLaboratory/redoc-cli@v1
35+
uses: DeltaLaboratory/redocly-cli@v1
3636
with:
37-
args: 'bundle test/petstore.yml'
37+
args: 'build-docs test/petstore.yml'
3838
```
3939
4040
The example is using the `bundle` command by providing the OpenAPI document `test/petstore.yml`.
@@ -46,7 +46,7 @@ Alternatively, you can point it to a file under a certain URL.
4646
- name: redoc-cli test
4747
uses: DeltaLaboratory/redoc-cli@v1
4848
with:
49-
args: 'bundle https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml'
49+
args: 'build-docs https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml'
5050
```
5151

5252
If you need to specify a custom name and destination for the output file, use the `-o` option like this:
@@ -55,5 +55,5 @@ If you need to specify a custom name and destination for the output file, use th
5555
- name: redoc-cli test
5656
uses: DeltaLaboratory/redoc-cli@v1
5757
with:
58-
args: 'bundle test/petstore.yml -o petstore.html'
58+
args: 'build-docs test/petstore.yml -o petstore.html'
5959
```

action.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
name: 'redoc-cli'
2-
description: 'Lets you use redoc-cli for generating REST API docs of your OpenAPI/Swagger documents.'
1+
name: 'redocly-cli'
2+
description: 'Lets you use redocly-cli for generating REST API docs of your OpenAPI/Swagger documents.'
33
author: 'DeltaLaboratory <delta@deltalab.dev>'
44
branding:
55
icon: 'book'
66
color: 'green'
77
inputs:
88
args:
9-
description: 'The arguments to pass over to redoc-cli'
9+
description: 'The arguments to pass over to redocly-cli'
1010
required: false
1111
default: ''
1212
runs:

generate-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
cd /github/workspace || exit
44

5-
echo "redoc-cli version: $(redocly --version)"
5+
echo "redocly cli version: $(redocly --version)"
66

77
# shellcheck disable=SC2086
88
redocly $1

0 commit comments

Comments
 (0)