From 5620c52142ed9fa44234de3c2bfbbb66240237b4 Mon Sep 17 00:00:00 2001 From: sunlei Date: Sat, 16 May 2026 09:28:58 +0800 Subject: [PATCH] =?UTF-8?q?ci:=20=E6=96=B0=E5=A2=9E=E5=89=8D=E5=8F=B0?= =?UTF-8?q?=E9=9D=99=E6=80=81=E5=8F=91=E5=B8=83=E6=B5=81=E6=B0=B4=E7=BA=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.example | 2 +- Jenkinsfile | 172 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 6 +- vite.config.ts | 3 +- 4 files changed, 177 insertions(+), 6 deletions(-) create mode 100644 Jenkinsfile diff --git a/.env.example b/.env.example index 942d86b..0eb8be3 100644 --- a/.env.example +++ b/.env.example @@ -1,5 +1,5 @@ NODE_ENV=development -VITE_APP_PLAY_GROUND=http://localhost:5173 +VITE_APP_PLAY_GROUND=http://localhost:48090 VITE_APP_PROXY=http://localhost:48085/ VITE_APP_BASE_API=/api VITE_APP_OSS_DOMAIN=/chart-assets diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..1718d30 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,172 @@ +def runCmd(String unixScript, String windowsScript = null) { + if (isUnix()) { + sh unixScript + } else { + bat(windowsScript ?: unixScript) + } +} + +def isPublishBranch(String branchName, String pattern) { + return branchName ==~ pattern +} + +pipeline { + agent { label 'kt-node-agent' } + + options { + skipDefaultCheckout(true) + timestamps() + disableConcurrentBuilds() + buildDiscarder(logRotator(numToKeepStr: '20', artifactNumToKeepStr: '10')) + } + + parameters { + booleanParam(name: 'DEPLOY_STATIC_FILES', defaultValue: true, description: '构建成功后是否发布 dist 到 Nginx 静态目录；仅发布分支生效') + string(name: 'PUBLISH_BRANCH_PATTERN', defaultValue: '^(main|master|release/.+)$', description: '允许发布静态文件的分支正则') + string(name: 'DEPLOY_TARGET_DIR', defaultValue: '/home/jenkins/agent/frontends/html/web', description: 'Nginx 挂载目录中 web 项目的静态文件目录') + string(name: 'PLAYGROUND_URL', defaultValue: 'http://192.168.31.224:48090', description: '构建进前台页面的 Playground 访问地址') + } + + environment { + CI = 'true' + PNPM_VERSION = '9' + VITE_APP_BASE_API = '/api' + VITE_APP_OSS_DOMAIN = '/chart-assets' + } + + stages { + stage('Checkout') { + steps { + checkout scm + } + } + + stage('Prepare') { + steps { + script { + env.IS_CHANGE_REQUEST = env.CHANGE_ID ? 'true' : 'false' + def publishPattern = params.PUBLISH_BRANCH_PATTERN?.trim() ?: '^(main|master|release/.+)$' + env.IS_PUBLISH_BRANCH = (!env.CHANGE_ID && isPublishBranch(env.BRANCH_NAME ?: '', publishPattern)) ? 'true' : 'false' + + if (isUnix()) { + runCmd(""" + node --version + if command -v corepack >/dev/null 2>&1; then + corepack enable + corepack prepare pnpm@${env.PNPM_VERSION} --activate + fi + if ! command -v pnpm >/dev/null 2>&1; then + echo "pnpm or corepack is required on the Jenkins Agent." + exit 1 + fi + pnpm --version + """.stripIndent()) + } else { + runCmd('', """ + node --version + where corepack >nul 2>nul + if not errorlevel 1 ( + corepack enable + corepack prepare pnpm@${env.PNPM_VERSION} --activate + ) + where pnpm >nul 2>nul + if errorlevel 1 exit /b 1 + pnpm --version + """.stripIndent()) + } + + echo """ + Branch: ${env.BRANCH_NAME ?: '-'} + Change request: ${env.CHANGE_ID ?: '-'} + Publish branch: ${env.IS_PUBLISH_BRANCH} + Deploy static files: ${params.DEPLOY_STATIC_FILES} + Deploy target: ${params.DEPLOY_TARGET_DIR} + Playground URL: ${params.PLAYGROUND_URL} + """.stripIndent() + } + } + } + + stage('Install') { + steps { + script { + runCmd('pnpm install --frozen-lockfile') + } + } + } + + stage('Build') { + steps { + script { + withEnv([ + "VITE_APP_PLAY_GROUND=${params.PLAYGROUND_URL}", + "VITE_APP_BASE_API=${env.VITE_APP_BASE_API}", + "VITE_APP_OSS_DOMAIN=${env.VITE_APP_OSS_DOMAIN}", + ]) { + runCmd('pnpm run build') + } + } + } + } + + stage('Deploy Static') { + when { + allOf { + expression { return params.DEPLOY_STATIC_FILES } + expression { return env.IS_CHANGE_REQUEST != 'true' } + expression { return env.IS_PUBLISH_BRANCH == 'true' } + } + } + steps { + script { + if (!isUnix()) { + error('Deploy Static stage requires a Linux/NAS Jenkins Agent.') + } + + def targetDir = params.DEPLOY_TARGET_DIR?.trim() + if (!targetDir) { + error('DEPLOY_TARGET_DIR is required when DEPLOY_STATIC_FILES is enabled.') + } + + // 先发布到临时目录再替换目标目录，避免 Nginx 读到半复制状态。 + withEnv(["TARGET_DIR=${targetDir}"]) { + runCmd(""" + set -e + test -f dist/index.html + + case "\${TARGET_DIR}" in + ""|"/"|"/home"|"/home/jenkins"|"/home/jenkins/agent"|"/usr"|"/usr/share"|"/usr/share/nginx"|"/usr/share/nginx/html") + echo "Unsafe DEPLOY_TARGET_DIR: \${TARGET_DIR}" + exit 1 + ;; + esac + + parent_dir=\$(dirname "\${TARGET_DIR}") + release_dir="\${TARGET_DIR}.release-${env.BUILD_NUMBER}" + previous_dir="\${TARGET_DIR}.previous" + + mkdir -p "\${parent_dir}" + rm -rf "\${release_dir}" "\${previous_dir}" + mkdir -p "\${release_dir}" + cp -a dist/. "\${release_dir}/" + + if [ -d "\${TARGET_DIR}" ]; then + mv "\${TARGET_DIR}" "\${previous_dir}" + fi + mv "\${release_dir}" "\${TARGET_DIR}" + rm -rf "\${previous_dir}" + + find "\${TARGET_DIR}" -maxdepth 2 -type f | head + """.stripIndent()) + } + } + } + } + } + + post { + success { + archiveArtifacts artifacts: 'dist/**,package.json,pnpm-lock.yaml,Jenkinsfile', fingerprint: true, allowEmptyArchive: true + } + } +} diff --git a/README.md b/README.md index 87358ff..fc39bb8 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ src ```env NODE_ENV=development -VITE_APP_PLAY_GROUND=http://localhost:5173 +VITE_APP_PLAY_GROUND=http://localhost:48090 VITE_APP_PROXY=http://localhost:48085/ VITE_APP_BASE_API=/api VITE_APP_OSS_DOMAIN=/chart-assets @@ -66,7 +66,7 @@ pnpm install pnpm dev ``` -开发服务默认端口为 `48088`。 +开发服务默认端口为 `48089`。 常用命令： @@ -106,7 +106,7 @@ pnpm deploy # 构建并执行部署脚本 示例： ```text -http://localhost:5173/?id=xxx&name=基础折线图&type=1&componentType=1#... +http://localhost:48090/?id=xxx&name=基础折线图&type=1&componentType=1#... ``` ## 开发约定 diff --git a/vite.config.ts b/vite.config.ts index d46daae..cd6c24c 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -9,7 +9,7 @@ export default ({ mode }) => { return defineConfig({ plugins: [vue(), UnoCSS()], server: { - port: 48088, + port: 48089, proxy: { "/api": { target: VITE_APP_PROXY, @@ -25,4 +25,3 @@ export default ({ mode }) => { }, }); }; -