Skip to content

Commit 038623e

Browse files
committed
docs: Add inputs description [skip ci]
1 parent 5db3979 commit 038623e

1 file changed

Lines changed: 45 additions & 4 deletions

File tree

README.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Jython tests](https://github.com/LukeSavefrogs/setup-jython/actions/workflows/test-action.yml/badge.svg)](https://github.com/LukeSavefrogs/setup-jython/actions/workflows/test-action.yml)
44
[![Source download URLs status](https://github.com/LukeSavefrogs/setup-jython/actions/workflows/test-urls.yml/badge.svg)](https://github.com/LukeSavefrogs/setup-jython/actions/workflows/test-urls.yml)
55

6-
This action provides the following functionality for GitHub Actions users:
6+
This action provides the following functionalities for GitHub Actions users:
77

88
- Installing a version of Jython and adding it to `PATH`
99
- Customizing the installation path
@@ -12,17 +12,58 @@ This action provides the following functionality for GitHub Actions users:
1212

1313
```yml
1414
steps:
15-
- uses: actions/checkout@v3
16-
1715
- name: Install Jython
1816
uses: LukeSavefrogs/setup-jython@v3
1917
with:
2018
jython-version: '2.5.2'
21-
installation-path: '~/jython/' # Default
2219

2320
- run: jython -c 'import sys, os; print(os.name, sys.version)';
2421
```
2522
23+
## Inputs
24+
25+
### `jython-version`
26+
27+
Specify the version of Jython to install. The value must be one of the versions listed in the [Supported versions](#supported-versions) section.
28+
29+
<table>
30+
<thead align=center>
31+
<tr>
32+
<th>Type</th>
33+
<th>Required</th>
34+
<th>Default</th>
35+
</tr>
36+
</thead>
37+
<tbody align=center>
38+
<tr>
39+
<td>string</td>
40+
<td>yes</td>
41+
<td>-</td>
42+
</tr>
43+
</tbody>
44+
</table>
45+
46+
### `installation-path`
47+
48+
Specify the path where Jython will be installed. Please note that this is usually not needed, since the binaries are always added to `PATH` anyway.
49+
50+
<table>
51+
<thead align=center>
52+
<tr>
53+
<th>Type</th>
54+
<th>Required</th>
55+
<th>Default</th>
56+
</tr>
57+
</thead>
58+
<tbody align=center>
59+
<tr>
60+
<td>string</td>
61+
<td>no</td>
62+
<td><code>~/jython/</code></td>
63+
</tr>
64+
</tbody>
65+
</table>
66+
2667
## Supported versions
2768

2869
This action supports all versions (_both stable and development releases_) currently listed on the official repositories:

0 commit comments

Comments
 (0)