Skip to content

Commit f46bb0f

Browse files
committed
Expand docs with default install behavior as of v2, non-default requirements.txt file paths. and toggle configs
1 parent dd36e87 commit f46bb0f

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,28 @@ None
2828

2929
### Default
3030

31-
Uses path `requirements.txt` and updates `pip` before the install.
31+
Uses path `requirements.txt` and updates `pip`, `setuptools`, and `wheel` before the install.
3232

3333
```yaml
3434
- name: Install Python dependencies
3535
uses: py-actions/py-dependency-install@v2
3636
```
3737
38-
### Disable `pip` update before install
38+
### Define the `requirements.txt` path
39+
40+
Define a requirements.txt file on a path relative to the root of your repository.
3941

4042
```yaml
4143
- name: Install Python dependencies
4244
uses: py-actions/py-dependency-install@v2
4345
with:
44-
update-pip: "false"
46+
path: "path/to/requirements.txt"
4547
```
4648

4749
### Toggle `pip`, `setuptools`, and `wheel` installs/updates off
4850

51+
The `pip`, `setuptools`, and `wheel` install/updates can be toggled off in your configuration. Use one or more of the `update-pip`, `update-setuptools`, and `update-wheel` settings with a boolean string to customize the default behavior:
52+
4953
```yaml
5054
- name: Install Python dependencies
5155
uses: py-actions/py-dependency-install@v2

0 commit comments

Comments
 (0)