diff --git a/_templates/README.md.erb b/_templates/README.md.erb index 8e5766f..219c09d 100644 --- a/_templates/README.md.erb +++ b/_templates/README.md.erb @@ -3,6 +3,14 @@ A [GitHub Action](https://github.com/features/actions) for using [Snyk](https://snyk.co/SnykGH) to check for vulnerabilities in your <%= @variant %> projects. This Action is based on the [Snyk CLI][cli-gh] and you can use [all of its options and capabilities][cli-ref] with the `args`. +<% if @name = "Python" %> > Note: The examples shared below reflect how Snyk github actions can be used. Snyk requires Python to have downloaded the dependencies before running or triggering the Snyk checks. + > The Python image checks and installs deps only if the manifest files are present in the current path (from where action is being triggered) + > 1. If pip is present on the current path , and Snyk finds a requirements.txt file, then Snyk runs pip install -r requirements.txt. + > 2. If pipenv is present on the current path, and Snyk finds a Pipfile without a Pipfile.lock, then Snyk runs pipenv update + > 3. If pyproject.toml is present in the current path and Snyk does not find poetry.lock then Snyk runs pip install poetry + > + > If manifest files are present under any location other root then they MUST be installed prior to running Snyk. +<% end %> You can use the Action as follows: ```yaml