docs: add workflows for docs (#120)

* docs: add workflows for docs

* forgot this

* format

* woopsie

* format again

* i gave this too much space

* update the lock

* Apply suggestions from code review

Co-authored-by: Scarlett Eliza <[email protected]>

---------

Co-authored-by: Felix Angelov <[email protected]>
Co-authored-by: Scarlett Eliza <[email protected]>

Author: 3 people

.github/workflows/site.yaml

@@ -0,0 +1,38 @@
+name: docs
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/site.yaml"
+      - "site/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: site
+
+    steps:
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v3
+
+      - name: ⚙️ Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: npm
+          cache-dependency-path: site/package-lock.json
+
+      - name: 📦 Install Dependencies
+        run: npm ci
+
+      - name: ✨ Check Format
+        run: npm run format:check
+
+      - name: 🧹 Lint
+        run: npm run lint
+
+      - name: 👷 Build website
+        run: npm run build

.github/workflows/site_deploy.yaml

@@ -0,0 +1,51 @@
+name: deploy
+
+on:
+  push:
+    paths:
+      - ".github/workflows/site_deploy.yaml"
+      - "site/**"
+    branches:
+      - main
+
+deploy:
+    name: Deploy to GitHub Pages
+
+    runs-on: ubuntu-latest
+
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+
+    defaults:
+      run:
+        working-directory: site
+
+    steps:
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v3
+
+      - name: ⚙️ Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: npm
+          cache-dependency-path: site/package-lock.json
+
+      - name: 📦 Install Dependencies
+        run: npm ci
+
+      - name: ✨ Check Format
+        run: npm run format:check
+
+      - name: 🧹 Lint
+        run: npm run lint
+
+      - name: 👷 Build website
+        run: npm run build
+
+      - name: ☁️ Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./site/build
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

site/docusaurus.config.js

@@ -17,8 +17,8 @@ const config = {
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'my-org', // Usually your GitHub org/user name.
-  projectName: 'my_docs_site', // Usually your repo name.
+  organizationName: 'VeryGoodOpenSource', // Usually your GitHub org/user name.
+  projectName: 'very_good_workflows', // Usually your repo name.
 
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want
@@ -37,7 +37,8 @@ const config = {
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
-          editUrl: 'https://github.com/my-org/my_docs_site/tree/main/',
+          editUrl:
+            'https://github.com/VeryGoodOpenSource/very_good_workflows/tree/main/site',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),