deploy

Author: avivkeller

.github/workflows/deploy.yml

@@ -0,0 +1,52 @@
+name: Deploy
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+
+permissions:
+    contents: read
+
+jobs:
+  # Build job
+  build:
+    # Specify runner +  build & upload the static files as an artifact
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
+        with:
+          node-version: lts/*
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: mkdir out && npm run build
+
+      - name: Upload static files as artifact
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
+        with:
+          path: out/
+          
+  deploy:
+    needs: build
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

.gitignore

@@ -1,2 +1,4 @@
 node_modules
-out
+out
+generated-*
+webpack

generate-md.mjs

@@ -7,14 +7,14 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 // Define all paths relative to the current file
-const entryPointsPath = resolve(__dirname, "../webpack/types.d.ts");
+const entryPointsPath = resolve(__dirname, "./webpack/types.d.ts");
 const tsconfigPath = resolve(__dirname, "./tsconfig.json");
 const dockitTheme = resolve(__dirname, "./plugins/theme/index.mjs");
 const consolidationPlugin = resolve(__dirname, "./plugins/consolidation.mjs");
 
 Application.bootstrapWithPlugins({
   entryPoints: [entryPointsPath],
-  out: "api",
+  out: "generated-api",
 
   // Plugins
   plugin: ["typedoc-plugin-markdown", consolidationPlugin, dockitTheme],

package.json

@@ -1,6 +1,6 @@
 {
   "scripts": {
-    "build": "node generate-md.mjs && doc-kit generate -t web -i api/webpack/namespaces/*.md -o out"
+    "build": "node generate-md.mjs && mkdir -p out && doc-kit generate -t web -i api/webpack/namespaces/*.md -o out"
   },
   "devDependencies": {
     "@node-core/doc-kit": "^1.0.1",

tsconfig.json

@@ -1,8 +1,8 @@
 {
   "include": [
-    "../webpack/lib/**/*",
-    "../webpack/declarations/lib/**/*",
-    "../webpack/types.d.ts"
+    "./webpack/lib/**/*",
+    "./webpack/declarations/lib/**/*",
+    "./webpack/types.d.ts"
   ],
   "compilerOptions": {
     "allowJs": true,