You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
1
# redoc-cli-github-action
2
2
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.
4
4
5
5
## Inputs
6
6
7
7
### `args`
8
8
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.
11
11
12
12
## Outputs
13
13
14
14
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`.
16
16
It's created in the root folder of the repository's workspace.
17
17
18
18
## Example usage
19
19
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.
21
21
22
22
```yaml
23
23
jobs:
@@ -32,9 +32,9 @@ jobs:
32
32
33
33
# then use redoc-cli-github-action to generate your HTML bundle
34
34
- name: redoc-cli test
35
-
uses: DeltaLaboratory/redoc-cli@v1
35
+
uses: DeltaLaboratory/redocly-cli@v1
36
36
with:
37
-
args: 'bundle test/petstore.yml'
37
+
args: 'build-docs test/petstore.yml'
38
38
```
39
39
40
40
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.
0 commit comments