feat: deploy 配置支持通过环境变量设置 (#174)

* feat: deploy 配置支持通过环境变量设置 --------- Co-authored-by: liaoxiaoyou <[email protected]>
qiniu · Jul 24, 2023 · 1b345db · 1b345db
1 parent 6eae30c
commit 1b345db
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 14 deletions.
diff --git a/build-config.md b/build-config.md
@@ -374,13 +374,25 @@ const apiUrl = "http://foobar.com/api" + 'test'
 
     ```json
     {
-      "AccessKey": "xxx",
-      "SecretKey": "yyy",
+      "accessKey": "xxx",
+      "secretKey": "yyy",
       "bucket": "zzz"
     }
     ```    
 
-    表示使用 `xxx`、`yyy` 分别作为 AccessKey 与 SecretKey，上传到名为 `zzz` 的 bucket。
+    表示使用 `xxx`、`yyy` 分别作为 accessKey 与 secretKey，上传到名为 `zzz` 的 bucket。
+
+    也可以通过环境变量的形式来配置，例如：
+
+    ```json
+    {
+      "accessKey": "{{process.env.BUILD_DEPLOY_ACCESS_KEY}}",
+      "secretKey": "{{process.env.BUILD_DEPLOY_SECRET_KEY}}",
+      "bucket": "zzz"
+    }
+    ```    
+
+    表示使用环境变量 `BUILD_DEPLOY_ACCESS_KEY`、`BUILD_DEPLOY_SECRET_KEY` 的值分别作为 accessKey 与 secretKey，上传到名为 `zzz` 的 bucket。
 
 ## **`test`**
 

diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "fec-builder",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "bin": {
     "fec-builder": "./lib/bin.js"
   },
@@ -43,6 +43,7 @@
     "lodash": "^4.17.20",
     "log4js": "^6.3.0",
     "mini-css-extract-plugin": "^1.3.9",
+    "mustache": "^4.2.0",
     "postcss-loader": "^4.3.0",
     "postcss-preset-env": "~7.2.3",
     "qiniu": "^7.3.2",
@@ -65,6 +66,7 @@
     "@types/css-minimizer-webpack-plugin": "^1.1.1",
     "@types/lodash": "^4.14.165",
     "@types/mini-css-extract-plugin": "^1.2.2",
+    "@types/mustache": "^4.2.2",
     "@types/postcss-preset-env": "^7.7.0",
     "@types/semver": "^7.3.4",
     "@types/walk": "^2.3.0",

diff --git a/preset-configs/config.schema.json b/preset-configs/config.schema.json
@@ -187,7 +187,7 @@
         "target": { "type": "string", "enum": ["qiniu"], "description": "部署目标" },
         "config": {
           "type": "object",
-          "description": "针对当前部署目标的配置信息，如 target 为 `\"qiniu\"` 时，需要提供的 config 形如：\n```json\n{\n  \"AccessKey\": \"xxx\",\n  \"SecretKey\": \"yyy\",\n  \"bucket\": \"zzz\"\n}\n```\n表示使用 `xxx`、`yyy` 分别作为 AccessKey 与 SecretKey，上传到名为 `zzz` 的 bucket。"
+          "description": "针对当前部署目标的配置信息，如 target 为 `\"qiniu\"` 时，需要提供的 config 形如：\n```json\n{\n  \"accessKey\": \"xxx\",\n  \"secretKey\": \"yyy\",\n  \"bucket\": \"zzz\"\n}\n```\n表示使用 `xxx`、`yyy` 分别作为 accessKey 与 secretKey，上传到名为 `zzz` 的 bucket。\n也可以通过环境变量的形式来配置，例如：\n```json\n{\n  \"accessKey\": \"{{process.env.BUILD_DEPLOY_ACCESS_KEY}}\",\n  \"secretKey\": \"{{process.env.BUILD_DEPLOY_SECRET_KEY}}\",\n  \"bucket\": \"zzz\"\n}\n```\n表示使用环境变量 `BUILD_DEPLOY_ACCESS_KEY`、`BUILD_DEPLOY_SECRET_KEY` 的值分别作为 accessKey 与 secretKey，上传到名为 `zzz` 的 bucket。"
         }
       }
     },

diff --git a/preset-configs/default.json b/preset-configs/default.json
@@ -73,8 +73,8 @@
   "deploy": {
     "target": "qiniu",
     "config": {
-      "AccessKey": "",
-      "SecretKey": "",
+      "accessKey": "",
+      "secretKey": "",
       "bucket": ""
     }
   },

diff --git a/src/upload.ts b/src/upload.ts
@@ -6,8 +6,9 @@
 import path from 'path'
 import walk from 'walk'
 import qiniu from 'qiniu'
+import Mustache from 'mustache'
 import logger from './utils/logger'
-import { findBuildConfig } from './utils/build-conf'
+import { Deploy, findBuildConfig } from './utils/build-conf'
 import { getDistPath } from './utils/paths'
 import { getPathFromUrl } from './utils'
 
@@ -117,12 +118,28 @@ async function uploadFile(localFile: string, bucket: string, key: string, mac: q
   return runWithRetry(putFile, 3)
 }
 
+function getDeployConfig(deploy: Deploy) {
+  const { config } = deploy
+  const model = {
+    process: {
+      env: process.env
+    }
+  }
+
+  return (Object.keys(config) as Array<keyof Deploy['config']>).reduce((prev, curr) => {
+    prev[curr] = Mustache.render(config[curr], model)
+    return prev
+  }, {} as Deploy['config'])
+}
+
 async function upload() {
   const buildConfig = await findBuildConfig()
-  const deployConfig = buildConfig.deploy.config
+  const { deploy, publicUrl } = buildConfig
   const distPath = getDistPath(buildConfig)
-  const prefix = getPathFromUrl(buildConfig.publicUrl, false)
-  const mac = new qiniu.auth.digest.Mac(deployConfig.accessKey, deployConfig.secretKey)
+  const prefix = getPathFromUrl(publicUrl, false)
+  const { accessKey, secretKey, bucket } = getDeployConfig(deploy)
+
+  const mac = new qiniu.auth.digest.Mac(accessKey, secretKey)
   const files = await getAllFiles(distPath)
 
   const concurrentLimit = 50
@@ -135,7 +152,7 @@ async function upload() {
       return logger.info(`[IGNORE] ${filePath}`)
     }
 
-    await uploadFile(filePath, deployConfig.bucket, key, mac)
+    await uploadFile(filePath, bucket, key, mac)
     logger.info(`[UPLOAD] ${filePath} -> ${key}`)
   }, concurrentLimit)