upload preview to surge.sh

Author: quarckster

.github/upload-preview.js

@@ -0,0 +1,75 @@
+import { Octokit } from '@octokit/rest';
+const { default: surge } = await import('surge');
+const octokit = new Octokit({ auth: process.env.GH_PR_TOKEN });
+const publishFn = surge().publish();
+
+// From github actions
+const ghrepo = process.env.GITHUB_REPOSITORY || '';
+const [owner, repo] = ghrepo.split('/');
+const prnum = process.env.GH_PR_NUM;
+const prbranch = process.env.GITHUB_REF.split('/').pop();
+
+const uploadFolder = process.argv[2];
+if (!uploadFolder) {
+  process.exit(1);
+}
+
+let uploadURL = `${repo}-${prnum ? `pr-${prnum}` : prbranch}`.replace(/[/|.]/g, '-');
+uploadURL += ".surge.sh"
+
+
+publishFn({
+  project: uploadFolder,
+  p: uploadFolder,
+  domain: uploadURL,
+  d: uploadURL,
+  e: 'https://surge.surge.sh',
+  endpoint: 'https://surge.surge.sh'
+});
+
+function tryAddComment(comment, commentBody) {
+  if (!commentBody.includes(comment)) {
+    return comment;
+  }
+  return '';
+}
+
+if (prnum) {
+  octokit.issues
+    .listComments({
+      owner,
+      repo,
+      issue_number: prnum
+    })
+    .then((res) => res.data)
+    .then((comments) => {
+      let commentBody = '';
+      const existingComment = comments.find((comment) => comment.user.login === 'openssl-machine');
+      if (existingComment) {
+        commentBody += existingComment.body.trim();
+        commentBody += '\n\n';
+      }
+
+      commentBody += tryAddComment(`Preview: https://${uploadURL}`, commentBody);
+
+      if (existingComment) {
+        octokit.issues
+          .updateComment({
+            owner,
+            repo,
+            comment_id: existingComment.id,
+            body: commentBody
+          })
+          .then(() => console.log('Updated comment!'));
+      } else {
+        octokit.issues
+          .createComment({
+            owner,
+            repo,
+            issue_number: prnum,
+            body: commentBody
+          })
+          .then(() => console.log('Created comment!'));
+      }
+    });
+}

.github/workflows/preview-pr.yml

@@ -1,11 +1,16 @@
-name: "Deploy site"
+name: "Build preview from PR"
 
 on:
   pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
+      SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+      GH_PR_TOKEN: ${{ secrets.GH_PR_TOKEN }}
+      GH_PR_NUM: ${{ github.event.number }}
     steps:
       - uses: actions/checkout@v4
       - name: "Fetch gh-pages branch"
@@ -20,4 +25,18 @@ jobs:
                    python build.py master"
       - name: "Fix ownership"
         run: sudo chown -R "${USER:-$(id -un)}" $(pwd)
-
+      - name: "Switch to gh-pages"
+        run: git switch gh-pages
+      - name: "Copy files"
+        run: rsync -r $(pwd) /tmp
+      - name: "Switch back"
+        run: git switch --detach -
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+      - name: "Install dependencies"
+        run: |
+          echo '{"type": "module"}' > package.json
+          npm install @types/node @octokit/rest surge
+      - name: "Upload site"
+        run: node .github/upload-preview.js /tmp/$(basename $(pwd))