Merge pull request #1 from basemind-ai/feat-add-workflows

chore: add workflows
basemind-ai · Dec 18, 2023 · 41df981 · 41df981
2 parents e3f3e0d + 2e68703
commit 41df981
Show file tree

Hide file tree

Showing 8 changed files with 184 additions and 6 deletions.
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+    - package-ecosystem: 'github-actions'
+      directory: '/'
+      schedule:
+          interval: 'daily'
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,48 @@
+name: CI
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+
+jobs:
+    validate:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Install Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 21
+            - name: Install PNPM
+              uses: pnpm/[email protected]
+              id: pnpm-install
+              with:
+                  version: 8
+                  run_install: false
+            - name: Setup Cache
+              id: pnpm-cache
+              shell: bash
+              run: |
+                  echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+            - name: Load Cached Dependencies
+              uses: actions/cache@v3
+              with:
+                  path: ${{ env.STORE_PATH }}
+                  key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-store-
+            - name: Install dependencies
+              run: pnpm install --ignore-scripts
+            - name: Lint
+              run: pnpm run lint
+            - name: Format
+              run: pnpm run format
+            - name: Spellcheck
+              run: pnpm run spellcheck
+            - name: Type Check
+              run: pnpm run typecheck
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -0,0 +1,52 @@
+name: Deploy
+
+on:
+    push:
+        branches:
+            - main
+
+permissions:
+    contents: write
+
+jobs:
+    deploy:
+        name: Deploy to GitHub Pages
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Install Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 21
+            - name: Install PNPM
+              uses: pnpm/[email protected]
+              id: pnpm-install
+              with:
+                  version: 8
+                  run_install: false
+            - name: Setup Cache
+              id: pnpm-cache
+              shell: bash
+              run: |
+                  echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+            - name: Load Cached Dependencies
+              uses: actions/cache@v3
+              with:
+                  path: ${{ env.STORE_PATH }}
+                  key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-store-
+            - name: Install dependencies
+              run: pnpm install --ignore-scripts
+            - name: Build
+              run: pnpm run build
+            - name: Deploy to GitHub Pages
+              uses: peaceiris/actions-gh-pages@v3
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./build
+                  # GH-Actions bot for deploys to `gh-pages` branch:
+                  # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+                  user_name: github-actions[bot]
+                  user_email: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/pr-title.yaml b/.github/workflows/pr-title.yaml
@@ -0,0 +1,20 @@
+name: 'Lint PR Title'
+
+on:
+    pull_request_target:
+        types:
+            - opened
+            - edited
+            - synchronize
+
+permissions:
+    pull-requests: read
+
+jobs:
+    main:
+        name: Validate PR title
+        runs-on: ubuntu-latest
+        steps:
+            - uses: amannn/action-semantic-pull-request@v5
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/test-build.yaml b/.github/workflows/test-build.yaml
@@ -0,0 +1,39 @@
+name: Build Test
+
+on:
+    pull_request:
+        branches:
+            - main
+jobs:
+    build_test:
+        name: Build Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Install Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 21
+            - name: Install PNPM
+              uses: pnpm/[email protected]
+              id: pnpm-install
+              with:
+                  version: 8
+                  run_install: false
+            - name: Setup Cache
+              id: pnpm-cache
+              shell: bash
+              run: |
+                  echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+            - name: Load Cached Dependencies
+              uses: actions/cache@v3
+              with:
+                  path: ${{ env.STORE_PATH }}
+                  key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-store-
+            - name: Install dependencies
+              run: pnpm install --ignore-scripts
+            - name: Build
+              run: pnpm run build
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -2,13 +2,17 @@ import type * as Preset from '@docusaurus/preset-classic';
 import type { Config } from '@docusaurus/types';
 import { themes as prismThemes } from 'prism-react-renderer';
 
+const basemind = 'BaseMind.AI';
+const deploymentBranch = 'gh-pages';
 const discordInviteLink = 'https://discord.gg/ReZ9SZwvwu';
 const docsSiteUrl = 'https://your-docusaurus-site.example.com';
 const logo = 'img/logo.svg';
-const organizationName = 'BaseMind.AI';
+const organizationName = 'basemind-ai';
+const repositoryName = 'docs';
 
 const config: Config = {
 	baseUrl: '/',
+	deploymentBranch,
 	favicon: 'img/favicon.ico',
 	i18n: {
 		defaultLocale: 'en',
@@ -32,7 +36,7 @@ const config: Config = {
 			} satisfies Preset.Options,
 		],
 	],
-	projectName: organizationName,
+	projectName: repositoryName,
 	tagline: '',
 	themeConfig: {
 		image: 'img/log-with-text.png',
@@ -52,17 +56,18 @@ const config: Config = {
 				},
 			],
 			logo: {
-				alt: `${organizationName} Logo`,
+				alt: `${basemind} Logo`,
 				src: logo,
 			},
-			title: organizationName,
+			title: basemind,
 		},
 		prism: {
 			darkTheme: prismThemes.dracula,
 			theme: prismThemes.github,
 		},
 	} satisfies Preset.ThemeConfig,
-	title: organizationName,
+	title: basemind,
+	trailingSlash: false,
 	url: docsSiteUrl,
 };
 

diff --git a/package.json b/package.json
@@ -21,7 +21,9 @@
 	"dependencies": {
 		"@docusaurus/core": "3.0.1",
 		"@docusaurus/preset-classic": "3.0.1",
+		"@docusaurus/theme-classic": "^3.0.1",
 		"@mdx-js/react": "^3.0.0",
+		"@types/node": "^20.10.5",
 		"clsx": "^2.0.0",
 		"prism-react-renderer": "^2.3.0",
 		"react": "^18.2.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml