Merge pull request #50 from layer5io/revert-49-build-preview-fix

Revert "clean up CI actions"

Author: Rajesh-Nagarajan-11

.github/actions/comment-preview-on-pr/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.7
+
+RUN pip install httpx "pydantic==1.5.1" pygithub
+
+COPY ./app /app
+
+CMD ["python", "/app/main.py"]

.github/actions/comment-preview-on-pr/action.yml

@@ -0,0 +1,13 @@
+name: Comment Preview in PR
+description: Comment the preview URL in the PR
+author: Sebastián Ramírez <[email protected]>
+inputs:
+  token:
+    description: Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}
+    required: true
+  deploy_url:
+    description: The deployment URL to comment in the PR
+    required: true
+runs:
+  using: docker
+  image: Dockerfile

.github/actions/comment-preview-on-pr/app/main.py

@@ -0,0 +1,70 @@
+import logging
+import sys
+from pathlib import Path
+from typing import Optional
+
+import httpx
+from github import Github
+from github.PullRequest import PullRequest
+from pydantic import BaseModel, BaseSettings, SecretStr, ValidationError
+
+github_api = "https://api.github.com"
+
+
+class Settings(BaseSettings):
+    github_repository: str
+    github_event_path: Path
+    github_event_name: Optional[str] = None
+    input_token: SecretStr
+    input_deploy_url: str
+
+
+class PartialGithubEventHeadCommit(BaseModel):
+    id: str
+
+
+class PartialGithubEventWorkflowRun(BaseModel):
+    head_commit: PartialGithubEventHeadCommit
+
+
+class PartialGithubEvent(BaseModel):
+    workflow_run: PartialGithubEventWorkflowRun
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    settings = Settings()
+    logging.info(f"Using config: {settings.json()}")
+    g = Github(settings.input_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    try:
+        event = PartialGithubEvent.parse_file(settings.github_event_path)
+    except ValidationError as e:
+        logging.error(f"Error parsing event file: {e.errors()}")
+        sys.exit(0)
+    use_pr: Optional[PullRequest] = None
+    for pr in repo.get_pulls():
+        if pr.head.sha == event.workflow_run.head_commit.id:
+            use_pr = pr
+            break
+    if not use_pr:
+        logging.error(
+            f"No PR found for hash: {event.workflow_run.head_commit.id}"
+        )
+        sys.exit(0)
+    github_headers = {
+        "Authorization": f"token {settings.input_token.get_secret_value()}"
+    }
+    url = f"{github_api}/repos/{settings.github_repository}/issues/{use_pr.number}/comments"
+    logging.info(f"Using comments URL: {url}")
+    response = httpx.post(
+        url,
+        headers=github_headers,
+        json={
+            "body": f"🚀 Preview for commit {use_pr.head.sha} at: {settings.input_deploy_url}"
+        },
+    )
+    if not (200 <= response.status_code <= 300):
+        logging.error(f"Error posting comment: {response.text}")
+        sys.exit(1)
+    logging.info("Finished")

.github/workflows/build-and-preview-site.yml

@@ -1,16 +1,16 @@
-name: Build Preview Site
+name: Build and Preview Site
 on:
   pull_request:
     branches: [master]
     types: [opened, synchronize, reopened, closed]
 
 concurrency:
-  group: pr-preview-build-${{ github.event.pull_request.number }}
+  group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
-
-# Only read permissions for building (safe for forks)
+    
 permissions:
-  contents: read
+  contents: write
+  pull-requests: write
 
 jobs:
   build:
@@ -37,23 +37,52 @@ jobs:
           bash .github/workflows/script.sh
 
       - name: Upload files
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@master
         with:
-          name: public-dir-pr-${{ github.event.pull_request.number }}
+          name: public-dir
           path: public-dir.zip
           retention-days: 1
-      
-      # Save PR metadata for the deploy workflow
-      - name: Save PR metadata
+
+  preview:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v6
+        
+      - name: Download pre-built site
+        if: github.event_name == 'pull_request'
+        uses: actions/download-artifact@v4
+        with:
+          name: public-dir
+          path: .
+
+      - name: Extract site
+        if: github.event_name == 'pull_request'
         run: |
-          mkdir -p ./pr-metadata
-          echo "${{ github.event.pull_request.number }}" > ./pr-metadata/pr_number
-          echo "${{ github.event.action }}" > ./pr-metadata/pr_action
-          echo "${{ github.event.pull_request.head.sha }}" > ./pr-metadata/pr_sha
-      
-      - name: Upload PR metadata
-        uses: actions/upload-artifact@v4
+          unzip -q public-dir.zip
+          # Ensure the extracted folder has the static files in a 'public' dir for the action
+          if [ -d "public-dir" ] && [ ! -d "public" ]; then
+            mv public-dir public
+          elif [ ! -d "public" ]; then
+            echo "Warning: Neither public nor public-dir found after extraction"
+          fi
+
+      - name: Deploy Preview
+        if: github.event_name == 'pull_request' && github.event.action != 'closed'
+        uses: rossjrw/[email protected]
+        with:
+          source-dir: public
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Remove Preview on Close
+        if: github.event_name == 'pull_request' && github.event.action == 'closed'
+        uses: rossjrw/[email protected]
         with:
-          name: pr-metadata-${{ github.event.pull_request.number }}
-          path: pr-metadata/
-          retention-days: 1
+          source-dir: public
+          remove: true
+          token: ${{ secrets.GITHUB_TOKEN }}