Configure GitHub Actions to run Super-Linter #3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This Pull Request sets up a GitHub Actions workflow that runs the GitHub Super-Linter on the entire codebase. It also formats the files according to the standards specified by the linters.
Super-Linter is a collection of
bash
scripts that run various "standard" linters for many different types of files. The hope is that this helps to:The linters that are in use right now are:
.markdown-lint.yml
.flake8
.python-lint
->.pylintrc
.python-black
- Note thatblack
will actually reformat your code for you, so just runblack .
before committing to fix everything up..isort.cfg
-isort
also automatically formats files for you (isort .
)The python linters can all be installed via
pip
. To make it simpler to install them on a development machine, this PR creates arequirements/dev.txt
file that can be used to create a virtual environment with the linters installed in addition to the core dependencies. Usingrequirements.txt
orrequirements/prod.txt
will install only those things needed for production.Finally, the configuration for the linters is borrowed from Super-Linter which attempts to provide some "best-practices" and also help ensure the linters all get along. There are two changes to the defaults:
.isort.cfg
.flake8