fix ci

Author: dmcilvaney

.github/workflows/check-rendered-specs.yml

@@ -68,20 +68,51 @@ jobs:
       - name: Check for drift
         id: check
         continue-on-error: true # Non-blocking while the feature stabilizes
+        env:
+          SPECS_DIR: ${{ steps.specs-dir.outputs.path }}
+        run: |
+          python .github/workflows/scripts/check_rendered_specs.py \
+            --specs-dir "$SPECS_DIR" \
+            --report render-check-report.json \
+            --patch rendered-specs.patch
+
+      - name: Upload fix patch
+        id: upload-patch
+        if: hashFiles('rendered-specs.patch') != ''
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+        with:
+          path: rendered-specs.patch
+          archive: false
+
+      # Also upload as a zipped artifact so `gh run download` works.
+      # The non-zipped upload above is for browser preview/download, but
+      # `gh run download` doesn't support non-zipped artifacts yet.
+      # See: https://github.com/cli/cli/issues/13012
+      - name: Upload fix patch (for gh cli)
+        if: hashFiles('rendered-specs.patch') != ''
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+        with:
+          name: rendered-specs-patch
+          path: rendered-specs.patch
+
+      - name: Post PR comment
+        if: always()
+        continue-on-error: true
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PR_REPO: ${{ github.repository }}
           PR_NUMBER: ${{ github.event.pull_request.number }}
           SPECS_DIR: ${{ steps.specs-dir.outputs.path }}
-          ARTIFACTS_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          PATCH_URL: ${{ steps.upload-patch.outputs.artifact-url }}
+          RUN_ID: ${{ github.run_id }}
         run: |
           python .github/workflows/scripts/check_rendered_specs.py \
             --specs-dir "$SPECS_DIR" \
             --repo "$PR_REPO" \
             --pr "$PR_NUMBER" \
             --report render-check-report.json \
-            --patch rendered-specs.patch \
-            --artifacts-url "$ARTIFACTS_URL"
+            --artifacts-url "$PATCH_URL" \
+            --run-id "$RUN_ID"
 
       - name: Upload render output
         if: always()
@@ -91,10 +122,3 @@ jobs:
           path: |
             render-output.json
             render-check-report.json
-
-      - name: Upload fix patch
-        if: hashFiles('rendered-specs.patch') != ''
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
-        with:
-          path: rendered-specs.patch
-          archive: false

.github/workflows/scripts/check_rendered_specs.py

@@ -222,7 +222,12 @@ def _render_command(components: list[str], use_all: bool = False) -> str:
     return f"azldev component render {' '.join(components)}"
 
 
-def format_comment(report: dict, artifacts_url: str | None = None) -> str:
+def format_comment(
+    report: dict,
+    artifacts_url: str | None = None,
+    run_id: str | None = None,
+    repo: str | None = None,
+) -> str:
     content_diffs = report.get("content_diffs", [])
     extra_files = report.get("extra_files", [])
     missing_files = report.get("missing_files", [])
@@ -265,14 +270,17 @@ def format_comment(report: dict, artifacts_url: str | None = None) -> str:
     ]
 
     if artifacts_url:
-        lines.append(
-            "Or download and apply the fix patch from the "
-            f"[workflow artifacts]({artifacts_url}#artifacts):"
-        )
+        lines.append(f"Or [download the fix patch]({artifacts_url}) and apply it:")
         lines.append("")
-        lines.append(
-            "```bash\n# Download 'rendered-specs.patch' from the link above, then:\ngit apply rendered-specs.patch\n```"
-        )
+        if run_id and repo:
+            lines.append(
+                "```bash\n"
+                f"gh run download {run_id} -R {repo} -n rendered-specs-patch\n"
+                "git apply rendered-specs.patch\n"
+                "```"
+            )
+        else:
+            lines.append("```bash\ngit apply rendered-specs.patch\n```")
         lines.append("")
 
     lines.extend(
@@ -393,7 +401,12 @@ def generate_patch(
             continue
         lines = text.splitlines(keepends=True)
         n = len(lines)
-        diff_body = "".join(f"+{line}" if line.endswith("\n") else f"+{line}\n\\ No newline at end of file\n" for line in lines)
+        diff_body = "".join(
+            f"+{line}"
+            if line.endswith("\n")
+            else f"+{line}\n\\ No newline at end of file\n"
+            for line in lines
+        )
         parts.append(
             f"diff --git a/{path_str} b/{path_str}\n"
             f"new file mode 100644\n"
@@ -408,7 +421,8 @@ def generate_patch(
         try:
             committed_bytes = subprocess.run(
                 ["git", "show", f"HEAD:{path_str}"],
-                capture_output=True, check=True,
+                capture_output=True,
+                check=True,
             ).stdout
         except subprocess.CalledProcessError:
             continue
@@ -423,7 +437,12 @@ def generate_patch(
             continue
         lines = text.splitlines(keepends=True)
         n = len(lines)
-        diff_body = "".join(f"-{line}" if line.endswith("\n") else f"-{line}\n\\ No newline at end of file\n" for line in lines)
+        diff_body = "".join(
+            f"-{line}"
+            if line.endswith("\n")
+            else f"-{line}\n\\ No newline at end of file\n"
+            for line in lines
+        )
         parts.append(
             f"diff --git a/{path_str} b/{path_str}\n"
             f"deleted file mode 100644\n"
@@ -535,6 +554,11 @@ def main() -> int:
         default=None,
         help="URL to the workflow run artifacts (linked in PR comment)",
     )
+    parser.add_argument(
+        "--run-id",
+        default=None,
+        help="GitHub Actions run ID (for gh run download command in PR comment)",
+    )
     args = parser.parse_args()
 
     if bool(args.repo) != bool(args.pr):
@@ -578,15 +602,22 @@ def main() -> int:
             if total == 0:
                 delete_comment_if_exists(args.repo, args.pr)
             else:
-                body = format_comment(report, artifacts_url=args.artifacts_url)
+                body = format_comment(
+                    report,
+                    artifacts_url=args.artifacts_url,
+                    run_id=args.run_id,
+                    repo=args.repo,
+                )
                 post_or_update_comment(args.repo, args.pr, body)
         except (subprocess.CalledProcessError, OSError) as exc:
             print(f"Warning: failed to post/update PR comment: {exc}", file=sys.stderr)
 
     # 5. Write to GitHub step summary if available
     summary_file = os.environ.get("GITHUB_STEP_SUMMARY")
     if summary_file and total > 0:
-        summary_body = format_comment(report, artifacts_url=args.artifacts_url)
+        summary_body = format_comment(
+            report, artifacts_url=args.artifacts_url, run_id=args.run_id, repo=args.repo
+        )
         if len(summary_body) <= MAX_STEP_SUMMARY:
             with open(summary_file, "a", encoding="utf-8") as sf:
                 sf.write(summary_body)