workflow to run stylecheck (#187)

* workflow to run stylecheck

* change to trigger check

* temp files

* secret for LLM

* fix archive name

* include commit ID

* fix date format again

* post full text of revision where suggestions are outside the PR diff

* control execution with label

* fixed label condition

* fixed success criteria

* include developer style rules

* run if label removed

Author: bc-devrev

.github/workflows/stylecheck.yml

@@ -0,0 +1,57 @@
+name: PR Review Suggestions
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled, unlabeled]
+    paths:
+      - '**.md'
+      - '**.mdx'
+
+jobs:
+  suggest:
+    if: contains(github.event.pull_request.labels.*.name, 'stylecheck') && !contains(github.event.pull_request.labels.*.name, 'stylecheck-complete')
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+
+      - name: Run stylecheck on changed files
+        id: stylecheck
+        env:
+          GITHUB_TOKEN: ${{ secrets.STYLECHECK }}
+          LLM_JWT: ${{ secrets.LLM_JWT }} 
+          REPO_OWNER: ${{ github.repository_owner }}
+          REPO_NAME: ${{ github.event.repository.name }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
+        run: |
+          echo "DATE=$(date +'%Y-%m-%d-%H%M%S')" >> $GITHUB_ENV
+          mkdir -p temp
+          for file in $(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} | grep -E '\.mdx?$'); do
+            python stylecheck.py --style=style/developer.md "$file"
+          done
+      - name: Add success label
+        if: success() && steps.stylecheck.outcome == 'success'
+        run: |
+          gh pr edit ${{ github.event.pull_request.number }} --add-label "stylecheck-complete"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Archive temp files
+        uses: actions/upload-artifact@v4
+        with:
+          name: stylecheck-${{ env.DATE }}
+          path: temp/**

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage
 
 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
-- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.
 
 ### Installing the Snap-in

stylecheck.py

@@ -116,7 +116,8 @@ def parse_diff_hunks(diff_text):
                     'path': path,
                     'line': old_start + old_lines - 1,
                     'side': 'RIGHT',
-                    'body': f'```suggestion\n{added_lines}\n```'
+                    'body': f'```suggestion\n{added_lines}\n```',
+                    'commit_id': os.environ.get('COMMIT_SHA')
                 }
                 if old_start < comment['line']:
                     comment['start_line'] = old_start
@@ -128,29 +129,33 @@ def parse_diff_hunks(diff_text):
 
     return comments
 
-def post_review_comment(owner, repo, pr_number, comment):
-    comment['commit_id'] = os.environ.get('COMMIT')
+def post_review_comment(comment):
+    owner = os.environ.get('REPO_OWNER')
+    repo = os.environ.get('REPO_NAME')
+    pr = os.environ.get('PR_NUMBER')
 
     if comment.get('line'):
         # Suggestion
-        url = f'https://api.github.com/repos/{owner}/{repo}/pulls/{pr_number}/comments'
+        url = f'https://api.github.com/repos/{owner}/{repo}/pulls/{pr}/comments'
         message = f"Posted comment on line {comment['line']}."
     else:
         # Timeline comment
-        url = f'https://api.github.com/repos/{owner}/{repo}/issues/{pr_number}/comments'
+        url = f'https://api.github.com/repos/{owner}/{repo}/issues/{pr}/comments'
         message = f"Posted comment on timeline."
 
     headers = {
-        'Authorization': f"token {os.environ.get('STYLECHECK')}",
+        'Authorization': f"token {os.environ.get('GITHUB_TOKEN')}",
         'Accept': 'application/vnd.github.v3+json'
     }
     try:
         response = requests.post(url, headers=headers, json=comment)
         response.raise_for_status()
         print(message)
+        return 0
     except Exception as e:
         print(
             f"Failed to post comment. Error: {type(e)} {e}")
+        return 1
 
 def my_writer(data, file, note=None):
     if (data):
@@ -192,11 +197,27 @@ def main(args):
 
     suggestions = parse_diff_hunks(diff)
     my_writer(suggestions, f"temp/{doc_name}_suggestions.json", 'suggestions')
+    failures = 0
     if (args.suggest):
-        post_review_comment(os.environ.get('OWNER'), os.environ.get('REPO'), os.environ.get('PR'), {'body': comment_text})
         for suggestion in suggestions:
             time.sleep(1)
-            post_review_comment(os.environ.get('OWNER'), os.environ.get('REPO'), os.environ.get('PR'), suggestion)
+            failures += post_review_comment(suggestion)
+        if failures > 0:
+            comment_text += f"""
+
+I made suggestions where possible but couldn't add them everywhere. My complete revision is below.
+
+<details><summary>Full text</summary>
+
+```
+{revision}
+```
+
+</details>
+
+"""
+        post_review_comment({'body': comment_text})
+
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Check writing style of markdown file")