Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating the python change in README template #105

Merged
merged 3 commits into from
Sep 19, 2022
Merged

Updating the python change in README template #105

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f35d68a
Updating the Python Snyk Action README with dependency information
akanchhaS Aug 29, 2022
f452523
Merge branch 'snyk:master' into master
akanchhaS Aug 30, 2022
c8be273
Updating the README template
akanchhaS Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions _templates/README.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down