chore: build and preview updates (#189)

* Run linting for push events to the default branch, as well as pull
  requests targeting the default branch
* Remove obsolete (unused) deploy workflow
* Reuse Vercel preview deploy scripts from cdr/m
* Cache Node.js dependencies
* Upgrade Node.js from 10 -> 12 for preview deployment
* Upgrade actions/setup-node from v1 to v2
* Use ubuntu-20.04 instead of ubuntu-latest to avoid build warning
* Add a comment with links and information for the preview

Author: Jonathan Yu

.github/ci/deploy.sh

@@ -1,16 +1,37 @@
 name: Quality
-on: push
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
 jobs:
   lint:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 12.x
-        uses: actions/setup-node@v1
+      - name: Cancel Previous Runs
+        if: github.ref != 'refs/heads/master'
+        uses: styfle/cancel-workflow-action@0.8.0
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Cache Node Modules
+        uses: actions/cache@v2
+        with:
+          path: "/node_modules"
+          key: node-${{ hashFiles('yarn.lock') }}
+
+      - name: Install Node.js
+        uses: actions/setup-node@v2
         with:
           node-version: 12.x
-      - name: Install node_modules
+
+      - name: Install Node Modules
         run: yarn
+
       - name: Lint
         run: yarn lint

.github/workflows/ci.yaml

@@ -1,33 +1,77 @@
-name: Deploy (Preview)
+name: Preview
 on:
-  push:
+  pull_request:
     branches:
-      - "**"
-      - "!master"
+      - master
 jobs:
   preview:
     name: Preview
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
-      - name: Checkout Mono
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.8.0
+
+      - name: Checkout m
         uses: actions/checkout@v2
         with:
           repository: cdr/m
           ref: refs/heads/master
           token: ${{ secrets.GH_ACCESS_TOKEN }}
           submodules: true
           fetch-depth: 0
-      - name: Checkout Docs
-        run: git fetch && git checkout ${GITHUB_SHA}
+
+      - name: Checkout docs
+        run: |
+          git fetch
+          git checkout "${{ github.head_ref }}"
         working-directory: ./product/coder.com/site/docs
-      - name: Setup Node
-        uses: actions/setup-node@v1
-      - name: Deploy
-        run: ./product/coder.com/site/docs/.github/ci/deploy.sh
+
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12.x
+
+      - name: Cache Node Modules
+        uses: actions/cache@v2
+        with:
+          path: "/node_modules"
+          key: node-${{ hashFiles('yarn.lock') }}
+
+      - name: Create Deployment
+        id: deployment
+        run: ./ci/scripts/github_deployment.sh create
         env:
           GITHUB_TOKEN: ${{ github.token }}
-          GITHUB_REF: ${{ github.ref }}
-          GITHUB_REPOSITORY: ${{ github.repository }}
-          VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+          DEPLOY_ENVIRONMENT: codercom-preview-docs
+
+      - name: Deploy Preview to Vercel
+        id: preview
+        run: ./ci/scripts/deploy_vercel.sh
+        env:
           VERCEL_ORG_ID: team_tGkWfhEGGelkkqUUm9nXq17r
           VERCEL_PROJECT_ID: QmZRucMRh3GFk1817ZgXjRVuw5fhTspHPHKct3JNQDEPGd
+          VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+
+      - name: Update Deployment
+        # If we don't specify always, it won't run this check if failed.
+        # This means the deployment would be stuck pending.
+        if: always()
+        run: ./ci/scripts/github_deployment.sh update
+        env:
+          GITHUB_DEPLOYMENT: ${{ steps.deployment.outputs.id }}
+          GITHUB_TOKEN: ${{ github.token }}
+          DEPLOY_STATUS: ${{ steps.preview.outcome }}
+          DEPLOY_URL: ${{ steps.preview.outputs.url }}
+
+      - name: Comment Credentials
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: always()
+        with:
+          header: codercom-preview-docs
+          message: |
+            ✨ Coder.com for PR #${{ github.event.number }} deployed! It will be updated on every commit.
+
+            * _Host_: ${{ steps.preview.outputs.url }}/docs
+            * _Last deploy status_: ${{ steps.preview.outcome }}
+            * _Commit_: ${{ github.sha }}
+            * _Workflow status_: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}