Skip to content

Commit dd36e87

Browse files
committed
[README.md] update documentation for v2.0.0 release
1 parent dfe2e33 commit dd36e87

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# py-actions/py-dependency-install GitHub Action
22

3-
This GitHub Action installs Python package dependencies from a user-defined `requirements.txt` file path with optional `pip`, `setuptools`, and `wheel` installs/updates during execution. A Python package environment report is displayed at the end of Action execution.
3+
This GitHub Action installs Python package dependencies from a user-defined `requirements.txt` file path with `pip`, `setuptools`, and `wheel` installs/updates during execution. A Python package environment report is displayed at the end of Action execution.
44

55
## Inputs
66

@@ -14,11 +14,11 @@ This GitHub Action installs Python package dependencies from a user-defined `req
1414

1515
### `update-setuptools`
1616

17-
**Optional** A boolean string indicating that a `setuptools` package update should occur before the dependency installation. Options: [`"true"`, `"false"`]. Default=`"false"`
17+
**Optional** A boolean string indicating that a `setuptools` package update should occur before the dependency installation. Options: [`"true"`, `"false"`]. Default=`"true"`
1818

1919
### `update-wheel`
2020

21-
**Optional** A boolean string indicating that a `wheel` package update should occur before the dependency installation. Options: [`"true"`, `"false"`]. Default=`"false"`
21+
**Optional** A boolean string indicating that a `wheel` package update should occur before the dependency installation. Options: [`"true"`, `"false"`]. Default=`"true"`
2222

2323
## Outputs
2424

@@ -32,27 +32,27 @@ Uses path `requirements.txt` and updates `pip` before the install.
3232

3333
```yaml
3434
- name: Install Python dependencies
35-
uses: py-actions/py-dependency-install@v1
35+
uses: py-actions/py-dependency-install@v2
3636
```
3737
3838
### Disable `pip` update before install
3939

4040
```yaml
4141
- name: Install Python dependencies
42-
uses: py-actions/py-dependency-install@v1
42+
uses: py-actions/py-dependency-install@v2
4343
with:
4444
update-pip: "false"
4545
```
4646

47-
### Configure `setuptools` and `wheel` installs/updates
47+
### Toggle `pip`, `setuptools`, and `wheel` installs/updates off
4848

4949
```yaml
5050
- name: Install Python dependencies
51-
uses: py-actions/py-dependency-install@v1
51+
uses: py-actions/py-dependency-install@v2
5252
with:
53-
update-pip: "true"
54-
update-setuptools: "true"
55-
update-wheel: "true"
53+
update-pip: "false"
54+
update-setuptools: "false"
55+
update-wheel: "false"
5656
```
5757

5858
## License

0 commit comments

Comments
 (0)