From dcee487737843c1d8e305cf6956790442d2345d0 Mon Sep 17 00:00:00 2001
From: Arthur Lu <learthurgo@gmail.com>
Date: Tue, 29 Nov 2022 22:18:32 +0000
Subject: [PATCH] add JSDoc ADR, add JSDoc to publish action

---
 .github/workflows/deploy-githubpages.yml  | 10 ++++++++++
 specs/adrs/112922-doccumentation-jsdoc.md | 17 +++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 specs/adrs/112922-doccumentation-jsdoc.md

diff --git a/.github/workflows/deploy-githubpages.yml b/.github/workflows/deploy-githubpages.yml
index 4909524..17c672b 100644
--- a/.github/workflows/deploy-githubpages.yml
+++ b/.github/workflows/deploy-githubpages.yml
@@ -29,8 +29,18 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
+      - name: Install apt updates
+        run: sudo apt -y update; sudo apt -y upgrade;
+      - name: Install prerequisites
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
       - name: Checkout
         uses: actions/checkout@v3
+      - name: Install dependencies
+        run: sudo npm install
+      - name: Run tests
+        run: sudo npm run js-doc
       - name: Setup Pages
         uses: actions/configure-pages@v2
       - name: Upload artifact
diff --git a/specs/adrs/112922-doccumentation-jsdoc.md b/specs/adrs/112922-doccumentation-jsdoc.md
new file mode 100644
index 0000000..a7e92df
--- /dev/null
+++ b/specs/adrs/112922-doccumentation-jsdoc.md
@@ -0,0 +1,17 @@
+# Use JSDoc for JS documentation
+
+- Status: accept
+- Deciders: Arthur Lu, Marc Reta
+- Date: 11 / 29 / 22
+
+## Decision Drivers
+
+- Need simple way to publish documentation for code
+- Already documentating infile using JSDoc style
+
+## Considered Options
+- JSDoc
+
+## Decision Outcome
+
+Chosen Option: JSDoc
\ No newline at end of file