Browse Source

docs: update docs [deploy] (#4037)

* docs: update docs [deploy]

* chore: update ci

* chore: update ci

* fix: ci error
Vben 9 months ago
parent
commit
36e33ea48a

+ 2 - 2
.github/ISSUE_TEMPLATE/feature-request.yml

@@ -13,8 +13,8 @@ body:
       label: Version
       description: What version of our software are you running?
       options:
-        - Vben Admin Pro
-        - Vben Admin
+        - Vben Admin V5
+        - Vben Admin V2
       default: 0
     validations:
       required: true

+ 8 - 3
.github/workflows/ci.yml

@@ -83,8 +83,8 @@ jobs:
         node-version: [20]
         os:
           - ubuntu-latest
-          # - macos-latest
-          # - windows-latest
+          - macos-latest
+          - windows-latest
 
     steps:
       - name: Checkout code
@@ -109,11 +109,15 @@ jobs:
 
   check:
     name: Check
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     timeout-minutes: 20
     strategy:
       matrix:
         node-version: [20]
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -137,6 +141,7 @@ jobs:
 
       # From https://github.com/rhysd/actionlint/blob/main/docs/usage.md#use-actionlint-on-github-actions
       - name: Check workflow files
+        if: runner.os == 'Linux'
         run: |
           bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
           ./actionlint -color -shellcheck=""

+ 1 - 1
.github/workflows/deploy.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   deploy-push-ftp:
     name: Deploy Push Ftp
-    if: github.actor != 'dependabot[bot]' && !contains(github.event.head_commit.message, '[skip ci]') && contains(github.event.head_commit.message, '[deploy]')
+    if: github.actor != 'dependabot[bot]' && !contains(github.event.head_commit.message, '[skip ci]')
     runs-on: ubuntu-latest
     strategy:
       matrix:

+ 1 - 1
.github/workflows/draft.yml

@@ -12,6 +12,6 @@ jobs:
   update_release_draft:
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@master
+      - uses: release-drafter/release-drafter@v6
         env:
           GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}

+ 1 - 1
.github/workflows/release-tag.yml

@@ -53,7 +53,7 @@ jobs:
           echo "version=${version}" >> $GITHUB_OUTPUT
           echo "major=${major}" >> $GITHUB_OUTPUT
 
-      - uses: release-drafter/release-drafter@master
+      - uses: release-drafter/release-drafter@v6
         with:
           version: ${{ steps.version.outputs.version }}
           publish: true

+ 3 - 3
.vscode/launch.json

@@ -3,10 +3,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "type": "chrome", // chrome、edge
-      "name": "vben admin dev", // 调试的名称,可以自定义
+      "type": "chrome",
+      "name": "vben admin antd dev",
       "request": "launch",
-      "url": "http://localhost:5173",
+      "url": "http://localhost:5555",
       "env": { "NODE_ENV": "development" },
       "sourceMaps": true,
       "webRoot": "${workspaceFolder}/apps/web-antd/src"

+ 1 - 3
.vscode/settings.json

@@ -163,9 +163,7 @@
     "yaml": false
   },
 
-  "cssVariables.lookupFiles": [
-    "packages/@vben-core/shared/design/src/**/*.css"
-  ],
+  "cssVariables.lookupFiles": ["packages/core/base/design/src/**/*.css"],
 
   "i18n-ally.localesPaths": [
     "packages/locales/src/langs",

+ 7 - 0
docs/src/guide/in-depth/loading.md

@@ -24,10 +24,17 @@ VITE_INJECT_APP_LOADING=false
 
 - 你可以使用跟`index.html`一样的语法,比如`VITE_APP_TITLE`变量,来获取应用的标题。
 - 必须保证有一个`id="__app-loading__"`的元素。
+- 给`id="__app-loading__"`的元素,加一个 `hidden` class。
 - 必须保证有一个`style[data-app-loading="inject-css"]`的元素。
 
 ```html{1,4}
 <style data-app-loading="inject-css">
+  #__app-loading__.hidden {
+    pointer-events: none;
+    visibility: hidden;
+    opacity: 0;
+    transition: all 1s ease-out;
+  }
   /* ... */
 </style>
 <div id="__app-loading__">

+ 1 - 1
docs/src/guide/project/standard.md

@@ -162,4 +162,4 @@ git hook 一般结合各种 lint,在 git 提交代码的时候进行代码风
 
 ### lint-staged
 
-用于自动修复提交文件风格问题,其配置文件为 `.lintstagedrc.mjs`,其核心配置放在`internal/lint-configs/lint-staged-config`目录下,可以根据项目需求进行修改。
+用于自动修复提交文件风格问题,其配置文件为 `.lintstagedrc.mjs`,可以根据项目需求进行修改。

+ 2 - 1
internal/vite-config/src/config/application.ts

@@ -8,7 +8,7 @@ import { findMonorepoRoot } from '@vben/node-utils';
 
 import { defineConfig, loadEnv, mergeConfig } from 'vite';
 
-import { getDefaultPwaOptions } from '../options';
+import { defaultImportmapOptions, getDefaultPwaOptions } from '../options';
 import { loadApplicationPlugins } from '../plugins';
 import { loadAndConvertEnv } from '../utils/env';
 import { getCommonConfig } from './common';
@@ -31,6 +31,7 @@ function defineApplicationConfig(userConfigPromise?: DefineApplicationOptions) {
       extraAppConfig: true,
       html: true,
       i18n: true,
+      importmapOptions: defaultImportmapOptions,
       injectAppLoading: true,
       injectMetadata: true,
       isBuild,