dependencies.md

Dependencies

Updating dependencies

To update a dependency:

• Update the dependency version in setup.py.
• Make any necessary changes.
• Run make update-pipfile-lock to update the Pipfile.lock file.
• File a PR.

Using an unreleased version of py-gitguardian

If you made changes to py-gitguardian and want to use them in GGShield there are a few steps you need to perform.

Locally

To use your changes locally:

• Activate ggshield virtual environment.
• Run pip install -e path/to/your/py-gitguardian/checkout.

You only need to do this once. From now on, changes you make in py-gitguardian are immediately available in ggshield.

In the CI

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

1. Update py-gitguardian dependency in setup.py to use a git+https URL, like this:

   setup(
       ...,
       # TODO: replace this with a real version number as soon as a new version of
       # py-gitguardian is out
       "pygitguardian @ git+https://github.com/GitGuardian/py-gitguardian.git@c6b941f8046de0188bc167d5a3d4ea7ebdd81e78",  # noqa: E501
       ...,
   )

2. Update the Pipfile.lock with make update-pipfile-lock.

Remember to do what the TODO comment says!