diff --git a/README.md b/README.md index 60017cb..a211ed6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Zero-configuration GitHub Action to maintain code quality with push and PR annotations. On every push and pull request git diffs will get inline annotated with found errors from -selected lintners. +selected linters. ![Screenshot of annotations](static/annotations.png) @@ -72,7 +72,7 @@ isort==isort-5.7.0 The python version you set up in your action script with `actions/setup-python@v2` or by other means will not affect the linting process. The python version used by -the lintners can be set up only by `conda-python-version` argument! This also means +the linters can be set up only by `conda-python-version` argument! This also means that if you modify the system conda environment it might affect the lintnig process. So it is best to keep the lintnig action separated from others. It is also recomended to run this on `ubuntu-latest`. Example: diff --git a/action.yml b/action.yml index 0771b3f..38b5242 100644 --- a/action.yml +++ b/action.yml @@ -84,12 +84,12 @@ runs: $CONDA/bin/conda --version $CONDA/bin/conda install python=${{ inputs.conda-python-version }} shell: bash - name: Install lintners + name: Install linters - run: | $CONDA/bin/python --version $CONDA/bin/pip install -r ${{ github.action_path }}/requirements.txt shell: bash - name: Install lintners + name: Install linters - run: > ${{ github.action_path }}/entrypoint.sh '${{ inputs.python-root-list }}' diff --git a/entrypoint.sh b/entrypoint.sh index 5d129ec..ef1596a 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -11,7 +11,7 @@ # $7 - use-isort # $8 - use-vulture # $9 - use-pydocstyle -# $10 - extra-pylint-options +# ${10} - extra-pylint-options # ${11} - extra-pycodestyle-options # ${12} - extra-flake8-options # ${13} - extra-black-options @@ -29,14 +29,14 @@ echo use-mypy: $6 echo use-isort: $7 echo use-vulture: $8 echo use-pydocstyle $9 -echo extra-pylint-options: $10 -echo extra-pycodestyle-options: $11 -echo extra-flake8-options: $12 -echo extra-black-options: $13 -echo extra-mypy-options: $14 -echo extra-isort-options: $15 -echo extra-vulture-options: $16 -echo extra-pydocstyle-options: $17 +echo extra-pylint-options: ${10} +echo extra-pycodestyle-options: ${11} +echo extra-flake8-options: ${12} +echo extra-black-options: ${13} +echo extra-mypy-options: ${14} +echo extra-isort-options: ${15} +echo extra-vulture-options: ${16} +echo extra-pydocstyle-options: ${17} # actions path has the copy of this actions repo for matcher in $GITHUB_ACTION_PATH/matchers/*.json @@ -49,9 +49,9 @@ export TERM=xterm if [ "$2" = true ] ; then - echo Running: pylint $9 $1 + echo Running: pylint ${10} $1 - $CONDA/bin/pylint --output-format="colorized" $9 $1 + $CONDA/bin/pylint --output-format="colorized" ${10} $1 exit_code=$? if [ "$exit_code" = "0" ]; then @@ -165,4 +165,4 @@ if [ "$9" = true ] ; then echo "pycodestyle error" fi -fi \ No newline at end of file +fi