Skip to content
This repository was archived by the owner on Feb 12, 2023. It is now read-only.

Commit 5ce48f8

Browse files
committed
update readme
1 parent 7c885cc commit 5ce48f8

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
- name: Checkout
2222
uses: actions/checkout@v2
2323
- name: Run DepHell
24-
uses: dephell/dephell_action@smoke
24+
uses: dephell/dephell_action@master
2525
with:
2626
dephell-env: main
2727
python-version: ${{ matrix.python-version }}

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,33 @@
22

33
An official [GitHub Action](https://help.github.com/en/actions) to run [DepHell](https://github.com/dephell/dephell) commands.
44

5+
Input variables:
6+
7+
- `dephell-env` -- DepHell environment to run.
8+
- `python-version` -- Python version to use when creating venv.
9+
- `dephell-version` -- DepHell version to install. The latest version is installed by default.
10+
11+
## Example
12+
13+
DepHell config (`pyproject.toml`):
14+
15+
```toml
16+
[tool.dephell.main]
17+
from = {format = "pip", path = "requirements.txt"}
18+
command = "pytest"
19+
```
20+
21+
GitHub Actions workflow (`.github/workflows/main.yml`):
22+
523
```yaml
24+
on:
25+
push:
26+
branches:
27+
- master
28+
pull_request:
29+
branches:
30+
- master
31+
632
jobs:
733
pytest:
834
runs-on: ubuntu-latest
@@ -14,8 +40,13 @@ jobs:
1440
uses: actions/setup-python@v2
1541
with:
1642
python-version: ${{ matrix.python-version }}
43+
- name: Checkout
44+
uses: actions/checkout@v2
1745
- name: Run DepHell
18-
uses: actions/dephell
46+
uses: dephell/dephell_action@master
1947
with:
2048
dephell-env: pytest
49+
python-version: ${{ matrix.python-version }}
2150
```
51+
52+
See [DepHell documentation](https://dephell.readthedocs.io/config.html) for details on configuring DepHell.

0 commit comments

Comments
 (0)