Merge pull request #74 from DSACMS/use-upstream-microsoft-pylint-action

Use Upstream Microsoft Pylint Action

Author: IsaacMilarky

.github/workflows/checks.yml

@@ -5,41 +5,15 @@ on:
 
 jobs:
   run-pylint:
+    name: runner / pylint
     permissions: write-all
     runs-on: ubuntu-latest
     steps:
-      - uses: LouisBrunner/[email protected]
-        id: init
+      - uses: actions/checkout@v2
+      - uses: dciborow/[email protected]
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          name: Pylint Report
-          status: in_progress
-      - uses: actions/checkout@v4
-      # update stats
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.9'
-      - name: cache pip
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - run: pip install -r requirements.txt
-      - run: |
-          PYLINT_REPORT=$(./run_pylint.sh)
-          echo "PYLINT_REPORT<<EOF" >> $GITHUB_ENV
-          echo "$PYLINT_REPORT" >> $GITHUB_ENV
-          echo 'EOF' >> $GITHUB_ENV
-            
-      - uses: LouisBrunner/[email protected]
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          check_id: ${{ steps.init.outputs.check_id }}
-          status: completed
-          conclusion: ${{ job.status }}
-          output: |
-            {"summary":"Pylint Report Generation ran with status: ${{job.status}}" , "text_description": "Pylint Issues are listed below."}
-          annotations: |
-            ${{ env.PYLINT_REPORT }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          level: warning
+          glob_pattern: "**/*.py"
+          filter_mode: "file"

run_pylint.sh

@@ -6,46 +6,3 @@
 
 def test_base_metric():
     raise NotImplementedError
-
-
-def run_pylint():
-    # Run pylint command and parse json
-    pylint_out = subprocess.run(['pylint', '--output-format=json',
-                                "--init-hook=\"import sys; sys.path.append('scripts/')\"", "scripts/*"], stdout=subprocess.PIPE, check=False)
-
-    pylint_list = json.loads(pylint_out.stdout)
-
-    # Parse pylint format into GitHub Checks Annotation format
-    for item in pylint_list:
-        # Rename error type to annotation_level
-        item['annotation_level'] = item.pop('type')
-
-        # translate pylint terms to github terms
-        if item['annotation_level'] == "convention":
-            item['annotation_level'] = 'notice'
-        elif item['annotation_level'] == "refactor":
-            item['annotation_level'] = 'warning'
-
-        # if end fields are empty, make them the same as the start
-        item['end_line'] = item.pop('endLine')
-        if item['end_line'] is None:
-            item['end_line'] = item['line']
-
-        item['start_line'] = item.pop('line')
-        item['start_column'] = item.pop('column')
-        item['end_column'] = item.pop('endColumn')
-        if item['end_column'] is None:
-            item['end_column'] = item['start_column']
-        item['title'] = item.pop('symbol')
-
-        # Don't include columns if annotation spans multiple lines
-        if item['start_line'] != item['end_line']:
-            item.pop('start_column')
-            item.pop('end_column')
-        item.pop('module')
-        item.pop('obj')
-        item.pop('message-id')
-    
-    to_return = pylint_list[:50]#json.dumps(pylint_list, indent=2)
-    #Print max of 50 terms since thats the max for GitHub
-    print(json.dumps(to_return, indent=2))