This repository was archived by the owner on May 20, 2026. It is now read-only.
feat: linting workflow #27
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: PyLint and flake8 linting | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened, labeled, unlabeled] | |
| workflow_call: | |
| jobs: | |
| linting: | |
| name: "Code Linting" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Get changed files | |
| id: changed-files | |
| uses: step-security/changed-files@v45.0.1 | |
| with: | |
| files: | | |
| **/*.py | |
| - name: Run PyLint | |
| id: pylint | |
| env: | |
| CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | |
| SKIP_DOCS: ${{ contains(github.event.pull_request.labels.*.name, 'skip-docs') }} | |
| SKIP_LINTING: ${{ contains(github.event.pull_request.labels.*.name, 'skip-linting') }} | |
| run: | | |
| if [[ -z "$CHANGED_FILES" ]]; then | |
| echo "Nothing to lint." | |
| echo "exit-code=0" | tee -a "$GITHUB_OUTPUT" | |
| exit 0 | |
| fi | |
| if [[ $SKIP_DOCS == true ]]; then | |
| ADDITIONAL_PYLINT_ARGS="--disable=C0115,C0116" | |
| else | |
| ADDITIONAL_PYLINT_ARGS="" | |
| fi | |
| if [[ $SKIP_LINTING == true ]]; then | |
| ADDITIONAL_PYLINT_ARGS="--exit-zero" | |
| fi | |
| pip install pylint | |
| set +e | |
| pylint $ADDITIONAL_PYLINT_ARGS --output pylintrc.txt --rcfile .pylintrc ${CHANGED_FILES[@]} | |
| echo "exit-code=$?" | tee -a "$GITHUB_OUTPUT" | |
| - name: Run flake8 | |
| id: flake8 | |
| env: | |
| CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | |
| SKIP_LINTING: ${{ contains(github.event.pull_request.labels.*.name, 'skip-linting') }} | |
| run: | | |
| if [[ -z "$CHANGED_FILES" ]]; then | |
| echo "Nothing to lint." | |
| echo "exit-code=0" | tee -a "$GITHUB_OUTPUT" | |
| exit 0 | |
| fi | |
| if [[ $SKIP_LINTING == true ]]; then | |
| ADDITIONAL_FLAKE8_ARGS="--exit-zero" | |
| else | |
| ADDITIONAL_FLAKE8_ARGS="" | |
| fi | |
| pip install flake8 | |
| set +e | |
| flake8 $ADDITIONAL_FLAKE8_ARGS --output flake8.txt --config .flake8 ${CHANGED_FILES[@]} | |
| echo "exit-code=$?" | tee -a "$GITHUB_OUTPUT" | |
| - name: Summary | |
| env: | |
| PYLINT: ${{ steps.pylint.outputs.exit-code == 0 }} | |
| FLAKE8: ${{ steps.flake8.outputs.exit-code == 0 }} | |
| run: | | |
| if [[ "$PYLINT" != "true" ]]; then | |
| echo "Pylint output:" | tee -a $GITHUB_STEP_SUMMARY | |
| echo '```' | tee -a $GITHUB_STEP_SUMMARY | |
| cat pylintrc.txt | tee -a $GITHUB_STEP_SUMMARY | |
| echo '```' | tee -a $GITHUB_STEP_SUMMARY | |
| fi | |
| if [[ "$FLAKE8" != "true" ]]; then | |
| echo "Flake8 output:" | tee -a $GITHUB_STEP_SUMMARY | |
| echo '```' | tee -a $GITHUB_STEP_SUMMARY | |
| cat flake8.txt | tee -a $GITHUB_STEP_SUMMARY | |
| echo '```' | tee -a $GITHUB_STEP_SUMMARY | |
| fi | |
| if [[ "$PYLINT" != "true" || "$FLAKE8" != "true" ]]; then | |
| exit 1 | |
| fi |