actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 16:21:00 -05:00
Code Issues Projects Releases Packages Wiki Activity

chore: explain how to configure the path (#6244)

Browse source 
Explain how to configure the PATH when installing new tools using pip.
This commit is contained in:
Marco Ferrari 2024-10-10 14:24:13 +02:00 committed by GitHub
parent c97987ce2a
commit 02081814d8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/add-new-linter.md
View file

@ -34,8 +34,18 @@ new tool needs in the `PATH`, and the expected version command:
- Install the tool by pointing to specific package or container image versions: - Install the tool by pointing to specific package or container image versions:
- If there are PyPi packages, create a text file named - If there are PyPi packages:
`dependencies/python/<name-of-tool>.txt` and list the packages there.
1. Create a text file named `dependencies/python/<name-of-tool>.txt` and
list the packages there.
1. Add the new virtual environment `bin` directory to the `PATH` in the
Super-linter `Dockerfile`, in the `Configure Environment` section.
Example:
```dockerfile
ENV PATH="${PATH}:/venvs/<name-of-tool>/bin"
```
- If there are npm packages, update `dependencies/package.json` and - If there are npm packages, update `dependencies/package.json` and
`dependencies/package-lock.json`. by adding the new packages. `dependencies/package-lock.json`. by adding the new packages.
- If there are Ruby Gems, update `dependencies/Gemfile` and - If there are Ruby Gems, update `dependencies/Gemfile` and