From f54e7cbd348e61f2700e6cb0baea5e7a6d007898 Mon Sep 17 00:00:00 2001
From: Neil Dewhurst <neil.dewhurst@neo4j.com>
Date: Thu, 3 Nov 2022 16:37:04 +0000
Subject: [PATCH] Add GHA workflows

---
 .github/workflows/docs-deploy-surge.yml | 67 +++++++++++++++++++++++++
 .github/workflows/docs-pr.yml           | 28 +++++++++++
 .github/workflows/docs-teardown.yml     | 26 ++++++++++
 3 files changed, 121 insertions(+)
 create mode 100644 .github/workflows/docs-deploy-surge.yml
 create mode 100644 .github/workflows/docs-pr.yml
 create mode 100644 .github/workflows/docs-teardown.yml

diff --git a/.github/workflows/docs-deploy-surge.yml b/.github/workflows/docs-deploy-surge.yml
new file mode 100644
index 000000000..764b0b850
--- /dev/null
+++ b/.github/workflows/docs-deploy-surge.yml
@@ -0,0 +1,67 @@
+# Use this starter workflow to deploy HTML generated by Antora to surge.sh
+# Docs are published at <org>-<repo>-<deployid>.surge.sh
+# By default, this workflow runs on completion of a workflow called "Verify PR"
+# This workflow expects the triggering workflow to generate an artifact called "docs"
+
+# - update the reference to "docs" and "docs.zip" in this workflow if your triggering workflow generates an artifact with a different name
+name: "Deploy to surge"
+
+on:
+  workflow_run:
+    workflows: ["Verify PR"]
+    types:
+      - completed
+
+jobs:
+  publish-docs:
+    if: github.event.workflow_run.conclusion == 'success'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: "Download built documentation"
+        uses: actions/github-script@v6.0.0
+        with:
+          script: |
+            var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: ${{ github.event.workflow_run.id }},
+            });
+            var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "docs"
+            })[0];
+            var download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            var fs = require('fs');
+            fs.writeFileSync('${{ github.workspace }}/docs.zip', Buffer.from(download.data));
+      
+      - run: unzip docs.zip
+      
+      - id: get-deploy-id
+        run: |
+          deployid=$(<deployid)
+          echo "::set-output name=deploy-id::$deployid"
+      
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      
+      - name: Deploy docs to surge
+        run: |
+          npm install -g surge
+          surge ./site ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}
+
+      - name: Comment on PR
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          number: ${{ steps.get-deploy-id.outputs.deploy-id }}
+          message: |
+            Looks like you've updated the documentation!
+
+            Check out your changes at https://${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh
+          GITHUB_TOKEN: ${{ secrets.PR_COMMENT_TOKEN }}
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
new file mode 100644
index 000000000..0c44b0159
--- /dev/null
+++ b/.github/workflows/docs-pr.yml
@@ -0,0 +1,28 @@
+# Use this starter workflow to verify PRs that include a change to the docs
+# The default setup runs against PRs targeting your default branch
+# Default artifact retention is 7 days
+
+name: "Verify PR"
+
+on:
+  pull_request:
+    branches:
+    - "4.4"
+    - "5.0"
+    - "5.x"
+    - "dev"
+
+jobs:
+
+  # note that the build job requires a build-verify script in package.json
+  # build-verify should build html with Antora, and output a .json log file
+  # eg 'antora playbook.yml --log-format=json --log-file ./build/log/log.json'
+  docs-build-for-pr:
+    uses: recrwplay/actions-demo/.github/workflows/reusable-docs-build.yml@main
+    with:
+      deploy-id: ${{ github.event.number }}
+      retain-artifacts: 14
+
+  docs-verify-for-pr:
+    needs: docs-build-for-pr
+    uses: recrwplay/actions-demo/.github/workflows/reusable-docs-verify.yml@main
diff --git a/.github/workflows/docs-teardown.yml b/.github/workflows/docs-teardown.yml
new file mode 100644
index 000000000..db50b305d
--- /dev/null
+++ b/.github/workflows/docs-teardown.yml
@@ -0,0 +1,26 @@
+#  copy this workflow into your repo
+name: "Documentation Teardown"
+
+on:
+  pull_request_target:
+    branches:
+      - "4.4"
+      - "5.0"
+      - "5.x"
+      - "dev"
+    types:
+      - closed
+
+jobs:
+  teardown-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - name: Teardown documentation
+        run: |
+          npm install -g surge
+          surge teardown ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ github.event.pull_request.number }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}
+