add previews

Author: artcz

.github/workflows/preview.yml

@@ -0,0 +1,82 @@
+name: Preview
+
+on:
+  pull_request:
+
+jobs:
+  preview:
+    name: Run preview
+    runs-on: ubuntu-latest
+    env:
+      PREVIEW_HOSTNAME: ep-preview.click
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            build
+
+      - name: Set up SSH key
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.DEPLOY_SSH_KEY }}
+
+      - name: Get current branch name
+        run: |
+          BRANCH_NAME=$(make safe_branch)
+          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV
+
+      - name: Upload preview
+        run: make preview
+
+      - name: Update PR Comment
+        uses: actions/github-script@v6
+        if: github.event_name == 'pull_request'
+
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            console.log("Hello world!");
+            const pr_id = ${{ github.event.number }};
+            console.log("PR Id %d", pr_id);
+
+            comments = await github.paginate(github.rest.issues.listComments, {
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: Number(pr_id)
+            })
+
+            const preview_identifier = "# Preview available"
+
+            let comment_id = null;
+            comments.forEach(comment => {
+              if(comment.body.indexOf(preview_identifier) >= 0) {
+                comment_id = comment.id;
+              }
+            });
+
+            const branch_name = process.env.BRANCH_NAME;
+            const url = "https://" + branch_name + "." + process.env.PREVIEW_HOSTNAME;
+            const timestamp = new Date().toISOString();
+            const header = "\n|Key|Value|\n|---|---|\n"
+            const body = preview_identifier + header + "|url|" + url + "|\n|last update|" + timestamp + "|";
+
+            if(comment_id > 0) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: comment_id,
+                body: body
+              });
+
+            } else {
+
+              await github.rest.issues.createComment({
+                issue_number: Number(pr_id),
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: body
+              });
+            }

Makefile

@@ -20,16 +20,11 @@ BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 SAFE_BRANCH := $(shell echo "$(BRANCH)" | sed 's/[^A-Za-z0-9._-]/-/g')
 FORCE_DEPLOY ?= false
 
-# TODO: update this to the prod branches
-ifeq ($(SAFE_BRANCH), ep2025)
-	RELEASES_DIR := $(VPS_PROD_PATH)/releases
-else
-	RELEASES_DIR := $(VPS_PREVIEW_PATH)/$(SAFE_BRANCH)/releases
-endif
+.PHONY: build deploy dev clean install
 
-TARGET := $(RELEASES_DIR)/$(TIMESTAMP)
 
-.PHONY: build deploy dev clean install
+safe_branch:
+	@echo $(SAFE_BRANCH)
 
 pre:
 	npm install -g pnpm
@@ -54,9 +49,20 @@ build:
 
 ifeq ($(FORCE_DEPLOY), true)
 deploy:
+	RELEASES_DIR := $(VPS_PROD_PATH)/releases
+	TARGET := $(RELEASES_DIR)/$(TIMESTAMP)
 	@echo "\n\n**** Deploying branch '$(BRANCH)' (safe: $(SAFE_BRANCH)) to $(TARGET)...\n\n"
 	$(REMOTE_CMD) "mkdir -p $(TARGET)"
 	rsync -avz --delete ./dist/ $(VPS_USER)@$(VPS_HOST):$(TARGET)/
 	$(REMOTE_CMD) "cd $(RELEASES_DIR) && ln -snf $(TIMESTAMP) current"
 	@echo "\n\n**** Deployment complete.\n\n"
 endif
+
+preview:
+	RELEASES_DIR := $(VPS_PREVIEW_PATH)/$(SAFE_BRANCH)/releases
+	TARGET := $(RELEASES_DIR)/$(TIMESTAMP)
+	@echo "\n\n**** Deploying preview of a branch '$(BRANCH)' (safe: $(SAFE_BRANCH)) to $(TARGET)...\n\n"
+	$(REMOTE_CMD) "mkdir -p $(TARGET)"
+	rsync -avz --delete ./dist/ $(VPS_USER)@$(VPS_HOST):$(TARGET)/
+	$(REMOTE_CMD) "cd $(RELEASES_DIR) && ln -snf $(TIMESTAMP) current"
+	@echo "\n\n**** Preview complete.\n\n"