chore: add github workflows

vectara · May 1, 2024 · 0b37083 · 0b37083
1 parent cc7e363
commit 0b37083
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 21 deletions.
diff --git a/.github/workflows/deploy-pages-site.yml b/.github/workflows/deploy-pages-site.yml
@@ -0,0 +1,24 @@
+name: Deploy to GitHub Pages
+on:
+  push:
+    branches: [chore/implement_gh_workflows]
+
+permissions:
+  contents: write
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+      - name: Build Page Script
+        run: |
+          npm i
+          npm run buildDocs
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: ./docs/public
+          clean-exclude: pr-preview/
diff --git a/.github/workflows/deploy-pr-preview.yml b/.github/workflows/deploy-pr-preview.yml
@@ -0,0 +1,25 @@
+# .github/workflows/preview.yml
+name: Deploy PR preview
+concurrency: preview-${{ github.ref }}
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm i && npm run buildDocs
+        env:
+          CI: false
+        if: github.event.action != 'closed'
+      - uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./docs/public
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: auto
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,10 @@
 # Deliberately commit dist folder so we can directly consume the repo as a dependency.
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
+# build files
+/docs/static
+/docs/public/static
+
 # dependencies
 /node_modules
 /.pnp

diff --git a/docs/asset-manifest.json b/docs/asset-manifest.json
diff --git a/docs/public/asset-manifest.json b/docs/public/asset-manifest.json
@@ -0,0 +1,15 @@
+{
+  "files": {
+    "main.css": "./static/css/main.2451c968.css",
+    "main.js": "./static/js/main.f22e287a.js",
+    "static/js/453.ebf7af86.chunk.js": "./static/js/453.ebf7af86.chunk.js",
+    "index.html": "./index.html",
+    "main.2451c968.css.map": "./static/css/main.2451c968.css.map",
+    "main.f22e287a.js.map": "./static/js/main.f22e287a.js.map",
+    "453.ebf7af86.chunk.js.map": "./static/js/453.ebf7af86.chunk.js.map"
+  },
+  "entrypoints": [
+    "static/css/main.2451c968.css",
+    "static/js/main.f22e287a.js"
+  ]
+}
diff --git a/docs/index.html → docs/public/index.html b/docs/index.html → docs/public/index.html
@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./vectara-favicon.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Vectara UI library"/><title>Vectara UI library</title><script defer="defer" src="./static/js/main.9d0ebd6a.js"></script><link href="./static/css/main.053ff0b9.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./vectara-favicon.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Vectara UI library"/><title>Vectara UI library</title><script defer="defer" src="./static/js/main.f22e287a.js"></script><link href="./static/css/main.2451c968.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
diff --git a/docs/robots.txt → docs/public/robots.txt b/docs/robots.txt → docs/public/robots.txt
diff --git a/docs/vectara-favicon.png → docs/public/vectara-favicon.png b/docs/vectara-favicon.png → docs/public/vectara-favicon.png
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vectara/vectara-ui",
   "version": "0.0.2",
-  "homepage": "./",
+  "homepage": "https://vectara.github.io/vectara-ui/",
   "description": "Vectara's design system, codified as a React and Sass component library",
   "author": "Vectara",
   "repository": {
@@ -25,7 +25,7 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "start": "PORT=2000 react-scripts start",
-    "buildDocs": "BUILD_PATH='./docs' react-scripts build",
+    "buildDocs": "BUILD_PATH='./docs/public' PUBLIC_URL='.' react-scripts build",
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "buildLib": "npx tsc --project tsconfig.lib.json && npm run copyStyleUtils && npm run copyComponentStyles && npm run compileCss",

diff --git a/src/docs/Docs.tsx b/src/docs/Docs.tsx
@@ -1,4 +1,4 @@
-import { Link, Navigate, Route, BrowserRouter as Router, Routes, useLocation } from "react-router-dom";
+import { Link, Navigate, Route, HashRouter as Router, Routes, useLocation } from "react-router-dom";
 import { BiLogoGithub } from "react-icons/bi";
 import {
   VuiAppHeader,
@@ -20,8 +20,7 @@ import "./index.scss";
 
 export const Docs = () => {
   return (
-    // Fix routing when deployed to GitHub pages (https://vectara.github.io/vectara-ui/).
-    <Router basename={process.env.NODE_ENV === "production" ? "/vectara-ui/" : undefined}>
+    <Router>
       <DocsContent />
     </Router>
   );
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./vectara-favicon.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Vectara UI library"/><title>Vectara UI library</title><script defer="defer" src="./static/js/main.9d0ebd6a.js"></script><link href="./static/css/main.053ff0b9.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
		<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./vectara-favicon.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Vectara UI library"/><title>Vectara UI library</title><script defer="defer" src="./static/js/main.f22e287a.js"></script><link href="./static/css/main.2451c968.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>