skip-linting label optionally disables lint checks (NVIDIA-NeMo#12179)

chtruong814 · web-flow · commit ad9c2968bea8 · 2025-02-18T09:38:07.000-06:00
* Add change in audio_to_text_dataset.py to test lint error Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Intentionally add error to flag pylint failure Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Flake8 errors do not fail CI check for speech domain Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Pylint errors do not fail the CI pipeline for speech domain Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Fix disabling linting errors for speech Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Move flake8 exit-zero config for speech Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Add --exit-zero to flake8 check if configured for domain Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Fix flake8 exit-zero condition Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Always output a summary for lint check Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Test failing lint check Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Add change in audio_to_text_dataset.py to test lint error" This reverts commit 6ee890d. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Intentionally add error to flag pylint failure" This reverts commit 6c64434. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Test failing lint check" This reverts commit 3a8cf06. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Use PR label skip-linting to disable linting Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Revert "Add change in audio_to_text_dataset.py to test lint error"" This reverts commit 453b943. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Revert "Intentionally add error to flag pylint failure"" This reverts commit 10078b2. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Revert "Test failing lint check"" This reverts commit ec64ff5. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Revert "Revert "Add change in audio_to_text_dataset.py to test lint error""" This reverts commit dcd781d. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Revert "Revert "Intentionally add error to flag pylint failure""" This reverts commit 0f05b26. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Revert "Revert "Test failing lint check""" This reverts commit e903cfd. Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Revert "Always output a summary for lint check" This reverts commit d11d60d. Signed-off-by: Charlie Truong <chtruong@nvidia.com> --------- Signed-off-by: Charlie Truong <chtruong@nvidia.com>
diff --git a/.flake8.speech b/.flake8.speech
@@ -6,4 +6,4 @@ select =
     F401, # 'x' imported but unused
     E741, # ambiguous variable name 'l'
     F821, # undefined name 'x'
-    E266, # too many leading '#' for block comment
+    E266, # too many leading '#' for block comment
diff --git a/.github/workflows/code-linting.yml b/.github/workflows/code-linting.yml
@@ -56,6 +56,7 @@ jobs:
         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.
@@ -69,6 +70,10 @@ jobs:
             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.$DOMAIN.txt" --rcfile ".pylintrc.$DOMAIN" ${CHANGED_FILES[@]}
@@ -78,16 +83,23 @@ jobs:
         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 --output "flake8.$DOMAIN.txt" --config ".flake8.$DOMAIN" ${CHANGED_FILES[@]}
+          flake8 $ADDITIONAL_FLAKE8_ARGS --output "flake8.$DOMAIN.txt" --config ".flake8.$DOMAIN" ${CHANGED_FILES[@]}
           echo "exit-code=$?" | tee -a "$GITHUB_OUTPUT"
 
       - name: Summary
