Rename actions and fix docusaurus search config

PufferFinance · May 28, 2024 · 9036410 · 9036410
1 parent 8a6b60e
commit 9036410
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -1,10 +1,11 @@
-name: Build and Test
+# This name appears on the "build" badge on README.
+name: build
 
 on:
   pull_request:
 
 jobs:
-  build-and-test:
+  build:
     runs-on: ubuntu-latest
 
     steps:

diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -1,9 +1,8 @@
-name: Deploy Docs
+name: deploy-docs
 
 on:
   release:
     types: [published]
-  push:
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,4 +1,4 @@
-name: Publish Package
+name: publish-package
 
 on:
   workflow_dispatch:
@@ -16,7 +16,7 @@ on:
           - prepatch
 
 jobs:
-  build:
+  publish-package:
     runs-on: ubuntu-latest
 
     permissions:

diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
@@ -137,7 +137,13 @@ const config: Config = {
     },
   } satisfies Preset.ThemeConfig,
   plugins: [
-    '@easyops-cn/docusaurus-search-local',
+    [
+      '@easyops-cn/docusaurus-search-local',
+      {
+        // For docs-only mode.
+        docsRouteBasePath: '/',
+      },
+    ],
     // Plugin for generating API docs.
     [
       'docusaurus-plugin-typedoc',