setup

HenryLok0 · HenryLok0 · commit c253b7e996bd · 2025-08-09T15:50:25.000+08:00
diff --git a/.github/workflows/codestate-pr-report.yml b/.github/workflows/codestate-pr-report.yml
@@ -10,7 +10,7 @@ jobs:
     name: Generate PR Code Report
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+  contents: write
       pull-requests: write
     steps:
       - name: Checkout
@@ -30,6 +30,57 @@ jobs:
         run: |
           python tools/codestate_pr_report.py
 
+      - name: Build Pages content
+        env:
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          GITHUB_SHA: ${{ github.sha }}
+        run: |
+          set -e
+          SHORT_SHA=$(git rev-parse --short "$GITHUB_SHA")
+          OUTDIR="site"
+          mkdir -p "$OUTDIR"
+          # Decide sub path
+          if [ -n "$PR_NUMBER" ]; then
+            SUBPATH="reports/pr-${PR_NUMBER}/sha-${SHORT_SHA}"
+          else
+            SUBPATH="reports/manual/sha-${SHORT_SHA}"
+          fi
+          mkdir -p "$OUTDIR/$SUBPATH"
+          # Copy report as index.html for direct open
+          if [ -f codestate_pr_report.html ]; then
+            cp codestate_pr_report.html "$OUTDIR/$SUBPATH/index.html"
+          else
+            echo "<html><body><h3>No report found</h3></body></html>" > "$OUTDIR/$SUBPATH/index.html"
+          fi
+          # Copy JSON for programmatic access
+          if [ -f codestate_pr_report.json ]; then
+            cp codestate_pr_report.json "$OUTDIR/$SUBPATH/codestate_pr_report.json"
+          fi
+          # Minimal landing index pointing to this run's page
+          cat > "$OUTDIR/index.html" << 'HTML'
+          <!doctype html>
+          <html lang="en"><head><meta charset="utf-8" />
+          <meta name="viewport" content="width=device-width, initial-scale=1" />
+          <title>CodeState Reports</title>
+          <style>body{font-family:system-ui,Segoe UI,Roboto,Helvetica,Arial,sans-serif;padding:24px;line-height:1.5}a{color:#2563eb}</style>
+          </head><body>
+          <h2>CodeState PR Reports</h2>
+          <p>This site hosts the latest generated PR report for this run.</p>
+          <p><a id="runLink" href="SUBPATH_PLACEHOLDER/">Open this run's report</a></p>
+          <p>Looking for older runs? Use the URL pattern: <code>/reports/pr-&lt;number&gt;/sha-&lt;short&gt;/</code></p>
+          </body></html>
+          HTML
+          # Inject subpath
+          sed -i "s|SUBPATH_PLACEHOLDER|$SUBPATH|g" "$OUTDIR/index.html"
+
+      - name: Publish to gh-pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./site
+          keep_files: true
+
       - name: Upload HTML artifact
         uses: actions/upload-artifact@v4
         with:
diff --git a/tools/codestate_pr_report.py b/tools/codestate_pr_report.py
@@ -6,6 +6,7 @@
 Outputs:
 - codestate_pr_report.md : Markdown content suitable for PR comments
 - codestate_pr_report.html : An HTML artifact with a detailed table
+- codestate_pr_report.json : Machine-readable payload
 
 Env (recommended):
 - BASE_SHA: base commit SHA (e.g., github.event.pull_request.base.sha)
@@ -15,9 +16,8 @@
 
 import os
 import re
-import sys
 import json
-import html
+import html as html_lib
 import shlex
 import subprocess
 from pathlib import Path
@@ -40,15 +40,13 @@ def run(cmd: str) -> Tuple[int, str, str]:
 
 
 def list_changed_files(base: str, head: str) -> List[str]:
-    # Include Added, Copied, Modified, Renamed, Type changed, Unmerged, Unknown, Broken
     cmd = f"git diff --name-only --diff-filter=ACMRTUXB {shlex.quote(base)}..{shlex.quote(head)}"
     code, out, err = run(cmd)
     if code != 0:
         print(f"::warning::Failed to list changed files: {err.strip()}\nFalling back to 'git diff --name-only' on HEAD.")
         code, out, _ = run("git diff --name-only")
     files = [line.strip() for line in out.splitlines() if line.strip()]
-    # Filter only supported extensions and existing files
-    result = []
+    result: List[str] = []
     for f in files:
         p = Path(f)
         if p.suffix.lower() in SUPPORTED_EXTS and p.exists() and p.is_file():
@@ -60,24 +58,20 @@ def estimate_comment_lines(ext: str, lines: List[str]) -> int:
     ext = ext.lower()
     comment = 0
     in_block = False
-    block_start = {'/*', "'''", '"""'}
     block_end = {'*/', "'''", '"""'}
     for raw in lines:
         s = raw.strip()
         if not s:
             continue
         if in_block:
             comment += 1
-            # Heuristic: close on end token appearance
             if any(tok in s for tok in block_end):
                 in_block = False
             continue
-        # Single-line styles
         if ext in {'.py'}:
             if s.startswith('#'):
                 comment += 1
                 continue
-            # Start of docstring block
             if s.startswith("'''") or s.startswith('"""'):
                 comment += 1
                 if not (s.endswith("'''") or s.endswith('"""')):
@@ -175,19 +169,16 @@ def render_markdown(by_ext: Dict[str, dict], per_file: List[dict]) -> str:
     if not per_file:
         return f"{title}\n\nNo supported code changes detected."
 
-    # Extension summary table
     exts = sorted(by_ext.values(), key=lambda x: (-x['total_lines'], x['ext']))
     header = "| ext | files | lines | comments | functions |\n|---|---:|---:|---:|---:|"
     rows = [
         f"| {e['ext']} | {e['file_count']} | {e['total_lines']} | {e['comment_lines']} | {e['function_count']} |"
         for e in exts
     ]
 
-    # Language distribution bars (by lines)
     max_lines = max((e['total_lines'] for e in exts), default=0)
     bars = [f"`{e['ext']}` {make_bar(e['total_lines'], max_lines)} {e['total_lines']}" for e in exts]
 
-    # Complexity heatmap (top 10)
     top_complex = sorted(per_file, key=lambda x: (-x['complexity'], -x['total_lines']))[:10]
     max_c = int(max((f['complexity'] for f in top_complex), default=0))
     heat = [
@@ -212,7 +203,7 @@ def render_markdown(by_ext: Dict[str, dict], per_file: List[dict]) -> str:
         md.append("- No files to display")
     md.append("")
     md.append(
-        "> Generated by CodeState PR reporter. An HTML report has been uploaded as a workflow artifact."
+        "> Generated by CodeState PR reporter. An HTML report has been uploaded as a workflow artifact and published to GitHub Pages."
     )
     return "\n".join(md)
 
@@ -221,7 +212,7 @@ def render_html(by_ext: Dict[str, dict], per_file: List[dict]) -> str:
     html_rows = []
     for f in sorted(per_file, key=lambda x: (-x['total_lines'], x['file'])):
         html_rows.append(
-            f"<tr><td>{html.escape(f['file'])}</td><td>{html.escape(f['ext'])}</td>"
+            f"<tr><td>{html_lib.escape(f['file'])}</td><td>{html_lib.escape(f['ext'])}</td>"
             f"<td style='text-align:right'>{f['total_lines']}</td>"
             f"<td style='text-align:right'>{f['comment_lines']}</td>"
             f"<td style='text-align:right'>{f['function_count']}</td>"
@@ -230,18 +221,18 @@ def render_html(by_ext: Dict[str, dict], per_file: List[dict]) -> str:
     ext_rows = []
     for e in sorted(by_ext.values(), key=lambda x: (-x['total_lines'], x['ext'])):
         ext_rows.append(
-            f"<tr><td>{html.escape(e['ext'])}</td>"
+            f"<tr><td>{html_lib.escape(e['ext'])}</td>"
             f"<td style='text-align:right'>{e['file_count']}</td>"
             f"<td style='text-align:right'>{e['total_lines']}</td>"
             f"<td style='text-align:right'>{e['comment_lines']}</td>"
             f"<td style='text-align:right'>{e['function_count']}</td></tr>"
         )
     return f"""
 <!doctype html>
-<html lang="en">
+<html lang=\"en\">
 <head>
-  <meta charset="utf-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta charset=\"utf-8\" />
+  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />
   <title>CodeState PR Report</title>
   <style>
     body {{ font-family: -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif; padding: 16px; }}
@@ -254,7 +245,7 @@ def render_html(by_ext: Dict[str, dict], per_file: List[dict]) -> str:
   </head>
 <body>
   <h2>CodeState PR Report — Changed Files</h2>
-  <p class="muted">This artifact lists per-file and per-extension metrics for the current pull request.</p>
+  <p class=\"muted\">This artifact lists per-file and per-extension metrics for the current pull request.</p>
   <table>
     <caption>Summary by extension</caption>
     <thead>
@@ -273,7 +264,7 @@ def render_html(by_ext: Dict[str, dict], per_file: List[dict]) -> str:
       {''.join(html_rows)}
     </tbody>
   </table>
-  <p class="muted">Generated by CodeState PR reporter.</p>
+  <p class=\"muted\">Generated by CodeState PR reporter.</p>
 </body>
 </html>
 """
@@ -283,8 +274,6 @@ def main() -> int:
     base = os.getenv('BASE_SHA') or os.getenv('GITHUB_BASE_SHA') or ''
     head = os.getenv('HEAD_SHA') or os.getenv('GITHUB_HEAD_SHA') or ''
     if not base or not head:
-        # Try to infer base from origin or default branch
-        # Fallback to HEAD~1..HEAD
         code, out, _ = run("git rev-parse HEAD")
         head = out.strip() if out.strip() else head
         code, out, _ = run("git rev-parse HEAD~1")
@@ -299,7 +288,6 @@ def main() -> int:
     Path('codestate_pr_report.md').write_text(md, encoding='utf-8')
     Path('codestate_pr_report.html').write_text(html_content, encoding='utf-8')
 
-    # Optional: also write a compact JSON for future automation
     payload = {
         'base': base, 'head': head, 'file_count': len(per_file),
         'by_ext': list(by_ext.values()), 'per_file': per_file,
