Skip to content

Commit 5af8d41

Browse files
docs(readme): add note regarding windows and java
1 parent 7962312 commit 5af8d41

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![test](https://github.com/remarkablemark/setup-openapi/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/setup-openapi/actions/workflows/test.yml)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
66

7-
⚙️ Set up GitHub Actions workflow with [OpenAPI Generator](https://openapi-generator.tech/docs/installation/).
7+
🟢 Set up GitHub Actions workflow with [OpenAPI Generator](https://openapi-generator.tech/docs/installation/).
88

99
## Quick Start
1010

@@ -38,6 +38,22 @@ Generate a Ruby client from a valid [petstore.yaml](https://petstore3.swagger.io
3838
3939
See [action.yml](action.yml)
4040
41+
> [!NOTE]
42+
> On Windows, you'll need to install a higher Java version:
43+
>
44+
> ```yaml
45+
> on: push
46+
> jobs:
47+
> openapi:
48+
> runs-on: windows-latest
49+
> steps:
50+
> - uses: actions/setup-java@v4
51+
> with:
52+
> distribution: temurin
53+
> java-version: 21
54+
> - uses: remarkablemark/setup-openapi@v1
55+
> ```
56+
4157
## Inputs
4258

4359
### `version`

0 commit comments

Comments
 (0)