Skip to content

Commit 039153f

Browse files
committed
doc: update documentation about dependencies
1 parent 648c480 commit 039153f

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed

.prettierignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

doc/dev/dependencies.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
To update a dependency:
66

7-
- Update the dependency version in `setup.py`.
7+
- Update the dependency version in `pyproject.toml`.
88
- Make any necessary changes.
9-
- Run `make update-pipfile-lock` to update the `Pipfile.lock` file.
9+
- Run `pdm update <dependency>` to update the lock file.
1010
- File a PR.
1111

1212
## Using an unreleased version of py-gitguardian
@@ -26,17 +26,18 @@ You only need to do this once. From now on, changes you make in py-gitguardian a
2626

2727
For the changes to pass on CI, you need to:
2828

29-
1. Update py-gitguardian dependency in `setup.cfg` to use a git+https URL, like this:
29+
1. Update py-gitguardian dependency in `pyproject.toml` to use a git+https URL, like this:
3030

31-
```python
32-
install_requires =
33-
...
34-
# TODO: replace this with a real version number as soon as a new version of
35-
# py-gitguardian is out
36-
pygitguardian @ git+https://github.com/GitGuardian/py-gitguardian.git@cfa919cff68cc4d3ca40bf2bb8a6f24bc5fca786
37-
...
31+
```
32+
dependencies = [
33+
(...)
34+
# TODO: replace this with a real version number as soon as a new version of
35+
# py-gitguardian is out
36+
"pygitguardian @ git+https://github.com/GitGuardian/py-gitguardian.git@cfa919cff68cc4d3ca40bf2bb8a6f24bc5fca786"
37+
(...)
38+
]
3839
```
3940

40-
2. Update the `Pipfile.lock` with `make update-pipfile-lock`.
41+
2. Run `pdm update pygitguardian`.
4142

4243
Remember to do what the `TODO` comment says!

0 commit comments

Comments
 (0)