chore: update documentation workflow

Author: xhyrom

.github/workflows/documentation.yml

@@ -1,57 +1,112 @@
-name: Build documentation
+# https://github.com/discordjs/discord.js/blob/main/.github/workflows/documentation.yml
+
+name: Documentation
 
 on:
   push:
     branches:
       - next
-  workflow_dispatch:
-  release:
-    types:
-      - published
+    tags:
+      - '**'
 
 jobs:
-  deploy:
+  build:
+    name: Build documentation
     runs-on: ubuntu-latest
-    if: ${{ (github.event_name == 'release') || (github.event_name == 'workflow_dispatch') }}
-
+    if: github.repository_owner == 'Garlic-Team'
+    outputs:
+      BRANCH_NAME: ${{ steps.env.outputs.BRANCH_NAME }}
+      BRANCH_OR_TAG: ${{ steps.env.outputs.BRANCH_OR_TAG }}
+      SHA: ${{ steps.env.outputs.SHA }}
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-      - name: Download
-        run: npm i @discordjs/ts-docgen typedoc-plugin-djs-links
+      - name: Install Node v16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
 
-      - name: Build
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build docs
         run: npm run build:docs
 
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v2
         with:
-          github_token: ${{ secrets.ACCESS_TOKEN }}
-          publish_dir: ./docs
-          publish_branch: docs
-          destination_dir: ./docs/
-          keep_files: true
+          name: docs
+          path: docs/docs.json
 
-  deploy_next:
-    runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'push' }}
+      - name: Set outputs for upload job
+        id: env
+        run: |
+          echo "::set-output name=BRANCH_NAME::${GITHUB_REF_NAME}"
+          echo "::set-output name=BRANCH_OR_TAG::${GITHUB_REF_TYPE}"
+          echo "::set-output name=SHA::${GITHUB_SHA}"
 
+  upload:
+    name: Upload Documentation
+    needs: build
+    runs-on: ubuntu-latest
+    env:
+      BRANCH_NAME: ${{ needs.build.outputs.BRANCH_NAME }}
+      BRANCH_OR_TAG: ${{ needs.build.outputs.BRANCH_OR_TAG }}
+      SHA: ${{ needs.build.outputs.SHA }}
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Download artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: docs
+          path: docs
 
-      - name: Download
-        run: npm i @discordjs/ts-docgen typedoc-plugin-djs-links
+      - name: Checkout docs repository
+        uses: actions/checkout@v2
+        with:
+          repository: 'discordjs/docs'
+          token: ${{ secrets.ACCESS_TOKEN }}
+          path: 'out'
 
-      - name: Build
-        run: npm run build:next-docs
+      - name: 'Extract package from tag'
+        if: env.BRANCH_OR_TAG == 'tag'
+        id: package-name
+        uses: frabert/[email protected]
+        with:
+          pattern: '(^@.*\\/(?<package>.*)@v?)?(?<semver>\\d+.\\d+.\\d+)-?.*'
+          string: ${{ env.BRANCH_NAME }}
+          replace-with: '$<package>'
 
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+      - name: 'Extract semver from tag'
+        if: env.BRANCH_OR_TAG == 'tag'
+        id: semver
+        uses: frabert/[email protected]
         with:
-          github_token: ${{ secrets.ACCESS_TOKEN }}
-          publish_dir: ./docs
-          publish_branch: docs
-          destination_dir: ./docs/
-          keep_files: true
+          pattern: '(^@.*\\/(?<package>.*)@v?)?(?<semver>\\d+.\\d+.\\d+)-?.*'
+          string: ${{ env.BRANCH_NAME }}
+          replace-with: '$<semver>'
+
+      - name: Move docs to correct directory
+        if: env.BRANCH_OR_TAG == 'tag'
+        env:
+          PACKAGE: ${{ steps.package-name.outputs.replaced }}
+          SEMVER: ${{ steps.semver.outputs.replaced }}
+        run: |
+          mkdir -p out/gcommands
+          mv docs/docs.json out/gcommands/${SEMVER}.json
+      - name: Move docs to correct directory
+        if: env.BRANCH_OR_TAG == 'branch'
+        env:
+          PACKAGE: ${{ matrix.package }}
+        run: |
+          mkdir -p out/gcommands
+          mv docs/docs.json out/gcommands/${BRANCH_NAME}.json
+      - name: Commit and push
+        run: |
+          cd out
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git add .
+          git commit -m "Docs build for ${BRANCH_OR_TAG} ${BRANCH_NAME}: ${SHA}" || true
+          git push

.npmignore

@@ -10,6 +10,5 @@ package-lock.json
 .commitlintrc.json
 .github/
 tsconfig.tsbuildinfo
-docs.yml
 tsconfig.json
 renovate.json

docs.yml docs/docs.yml

@@ -2,4 +2,4 @@
   files:
     - name: Welcome
       id: welcome
-      path: ../README.md
+      path: ../README.md

scripts/docs.mjs

@@ -1,7 +1,7 @@
-import {runGenerator} from '@discordjs/ts-docgen';
+import { runGenerator } from '@discordjs/ts-docgen';
 
 runGenerator({
-	existingOutput: 'docs/out-latest.json',
-	output: 'docs/latest.json',
-    custom: 'docs.yml'
+	existingOutput: 'docs/typedoc-out.json',
+	output: 'docs/docs.json',
+    custom: 'docs/docs.yml'
 });