vcs-patch-deploy 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,11 @@
1
+ # Changelog
2
+
3
+ ## 1.0.1
4
+
5
+ - 文档与示例改用通用占位路径,移除项目专有目录名
6
+ - `apply-update.php` 仅保留 `PATCH_BACKEND_ROOT` 环境变量
7
+ - 补充 GitHub 仓库链接
8
+
9
+ ## 1.0.0
10
+
11
+ - 首次发布:PHP 后端增量部署,支持 SVN / Git
package/README.md CHANGED
@@ -2,6 +2,9 @@
2
2
 
3
3
  PHP 后端(ThinkPHP)增量部署包生成工具。对比 **SVN revision** 或 **Git commit** 差异,生成本地 zip,附带 `apply-update.php`,供堡垒机 / Web 终端上线。
4
4
 
5
+ - npm:https://www.npmjs.com/package/vcs-patch-deploy
6
+ - GitHub:https://github.com/QINGYUAI/vcs-patch-deploy
7
+
5
8
  > v1 仅内置 **PHP 后端**配置;Node/Java 等后端可在后续版本通过 `--backend` 扩展。
6
9
 
7
10
  ## 安装
@@ -15,8 +18,10 @@ npx patch-build --help
15
18
 
16
19
  ## 快速开始(ThinkPHP + SVN)
17
20
 
21
+ 在 **PHP 项目根目录**(含 `app/`、`config/` 或 `think`)执行:
22
+
18
23
  ```bash
19
- cd BackendSVN/trunk
24
+ cd /path/to/your-php-api
20
25
 
21
26
  # 首次:初始化 deploy 目录
22
27
  patch-build --init --vcs=svn
@@ -32,10 +37,12 @@ patch-build --vcs=svn
32
37
  # deploy/out/patch-r{rev}/
33
38
  ```
34
39
 
40
+ SVN 常见目录结构为 `repo-root/trunk`,进入 `trunk` 后执行上述命令即可。
41
+
35
42
  ## Git 仓库
36
43
 
37
44
  ```bash
38
- cd BackendSVN/trunk # 若 trunk 为 Git 仓库
45
+ cd /path/to/your-php-api
39
46
 
40
47
  echo git:abc123def... > deploy/.last-deploy-marker
41
48
  patch-build --vcs=git
@@ -48,11 +55,11 @@ patch-build --vcs=git --from=v1.0.0 --to=HEAD
48
55
  unzip -o backend-update-r467.zip -d patch-r467
49
56
  cd patch-r467
50
57
 
51
- php apply-update.php --check /usr/local/tool/THS/html/BackendSVN/Backend
52
- php apply-update.php /usr/local/tool/THS/html/BackendServer/Backend
58
+ php apply-update.php --check /path/to/production-api
59
+ php apply-update.php /path/to/production-api
53
60
 
54
61
  # 或环境变量
55
- export PATCH_BACKEND_ROOT=/path/to/backend
62
+ export PATCH_BACKEND_ROOT=/path/to/production-api
56
63
  php apply-update.php
57
64
  ```
58
65
 
@@ -88,19 +95,23 @@ php apply-update.php
88
95
  | 文件 | 格式 |
89
96
  |------|------|
90
97
  | `deploy/.last-deploy-marker` | `svn:467` 或 `git:fullsha` |
91
- | `deploy/.last-deploy-rev` | 兼容旧版 SVN(仅数字) |
98
+ | `deploy/.last-deploy-rev` | 兼容旧版 SVN 工具(仅数字) |
92
99
 
93
100
  **上线成功后再更新基准**,否则下次增量会漏文件。
94
101
 
95
102
  ## 编程式调用
96
103
 
104
+ 默认以 **当前工作目录** 为 PHP 项目根,无需写死路径:
105
+
97
106
  ```javascript
107
+ const path = require('path')
98
108
  const { buildPatch, resolveConfig } = require('vcs-patch-deploy')
99
109
 
110
+ // 在 PHP 项目根目录运行,或显式指定 sourceDir
100
111
  const config = resolveConfig({
101
112
  backend: 'php',
102
113
  vcs: 'svn',
103
- sourceDir: 'D:/Work/web/newKJCG/BackendSVN/trunk',
114
+ cwd: path.join(__dirname), // 调用方项目根
104
115
  fromRef: 430,
105
116
  toRef: 467
106
117
  })
@@ -108,6 +119,14 @@ const config = resolveConfig({
108
119
  buildPatch(config).then(console.log)
109
120
  ```
110
121
 
122
+ 也可通过环境变量配置(见 `env.example`):
123
+
124
+ ```bash
125
+ export PATCH_SOURCE_DIR=/path/to/your-php-api
126
+ export PATCH_VCS=svn
127
+ patch-build
128
+ ```
129
+
111
130
  ## License
112
131
 
113
132
  MIT
@@ -5,9 +5,9 @@ declare(strict_types=1);
5
5
  * 堡垒机增量部署:将 patch 包内文件覆盖到线上 Backend 根目录,并清理 ThinkPHP 缓存。
6
6
  *
7
7
  * 用法(Linux Web 终端,在解压后的 patch 目录内):
8
- * php apply-update.php /www/kjcg-api
8
+ * php apply-update.php /path/to/production-api
9
9
  * 或设置环境变量:
10
- * KJCG_BACKEND_ROOT=/www/kjcg-api php apply-update.php
10
+ * PATCH_BACKEND_ROOT=/path/to/production-api php apply-update.php
11
11
  *
12
12
  * 安全:不会覆盖 .env;不会自动删除 MANIFEST-deleted.txt 中列出的文件。
13
13
  */
@@ -41,7 +41,7 @@ const SKIP_PATH_PREFIXES = [
41
41
  */
42
42
  function resolveBackendRoot(): string
43
43
  {
44
- foreach (['PATCH_BACKEND_ROOT', 'KJCG_BACKEND_ROOT'] as $envKey) {
44
+ foreach (['PATCH_BACKEND_ROOT'] as $envKey) {
45
45
  $fromEnv = getenv($envKey);
46
46
  if (is_string($fromEnv) && $fromEnv !== '') {
47
47
  return rtrim($fromEnv, "/\\");
@@ -63,7 +63,7 @@ function resolveBackendRoot(): string
63
63
  }
64
64
 
65
65
  fwrite(STDERR, "用法: php apply-update.php [--check] <Backend根目录>\n");
66
- fwrite(STDERR, "示例: php apply-update.php /usr/local/tool/THS/html/BackendSVN/Backend\n");
66
+ fwrite(STDERR, "示例: php apply-update.php /path/to/production-api\n");
67
67
  exit(1);
68
68
  }
69
69
 
@@ -332,7 +332,7 @@ if ($fail > 0) {
332
332
  $phpBin = detectPhpBinary();
333
333
  echo "\n--- 权限排查 ---\n";
334
334
  echo "当前终端用户「{$runUser}」无法覆盖 app/ 下 PHP 文件(runtime/cache 可写不代表源码可写)。\n";
335
- echo "源码属主与 PHP-FPM 不一致时,THS 常见:文件 UID 48 无 passwd 条目,而 php-fpm 以 nyncb 运行。\n";
335
+ echo "源码属主与 PHP-FPM 不一致时较常见:Web 终端用户与 php-fpm 运行用户不同。\n";
336
336
  echo "建议: sudo chown -R {$runUser}:{$runUser} {$backendRoot}/app 后,再以 {$runUser} 执行本脚本;或 sudo cp 覆盖。\n";
337
337
  echo "请在 Backend 根目录执行:\n";
338
338
  echo " whoami\n";
@@ -342,8 +342,8 @@ if ($fail > 0) {
342
342
  echo "常见处理方式(择一,需运维配合):\n";
343
343
  echo " 1) sudo chown -R {$runUser}:{$runUser} {$backendRoot}/app && {$phpBin} apply-update.php {$backendRoot}\n";
344
344
  echo " 2) sudo cp -f app/service/... {$backendRoot}/app/service/...(在 patch 目录内)\n";
345
- echo " 3) 请运维在 THS 控制台代为覆盖 patch 内文件\n";
346
- echo "注意: 本 THS 环境通常无 www/nginx/apache 用户,勿用 sudo -u nginx。\n";
345
+ echo " 3) 请运维在面板/堡垒机代为覆盖 patch 内文件\n";
346
+ echo "注意: 勿假设固定系统用户(如 nginx/www),以 whoami 与 ls -ln 实际属主为准。\n";
347
347
  if ($blocked !== []) {
348
348
  echo "\n未写入文件数: " . count($blocked) . "\n";
349
349
  }
@@ -42,12 +42,12 @@ ${chalk.yellow('环境变量:')}
42
42
  PATCH_DEPLOY_DIR deploy 目录
43
43
  PATCH_ZIP_PREFIX zip 前缀
44
44
 
45
- ${chalk.yellow('ThinkPHP + SVN(BackendSVN/trunk):')}
46
- cd BackendSVN/trunk
45
+ ${chalk.yellow('ThinkPHP + SVN:')}
46
+ cd /path/to/your-php-api
47
47
  patch-build --vcs=svn
48
48
 
49
49
  ${chalk.yellow('ThinkPHP + Git:')}
50
- cd BackendSVN/trunk
50
+ cd /path/to/your-php-api
51
51
  patch-build --vcs=git --from=<commit> --to=HEAD
52
52
 
53
53
  ${chalk.yellow('服务器应用:')}
package/env.example CHANGED
@@ -6,11 +6,11 @@ PATCH_BACKEND=php
6
6
  # svn | git;留空则自动检测
7
7
  # PATCH_VCS=svn
8
8
 
9
- # PHP 项目根(ThinkPHP 含 app/ config/ 的 trunk 或 Git 仓库根)
10
- # PATCH_SOURCE_DIR=D:/Work/web/newKJCG/BackendSVN/trunk
9
+ # PHP 项目根(ThinkPHP 含 app/ config/ 的目录)
10
+ # PATCH_SOURCE_DIR=/path/to/your-php-api
11
11
 
12
12
  # deploy 配置目录(含 .last-deploy-marker、out/)
13
- # PATCH_DEPLOY_DIR=D:/Work/web/newKJCG/BackendSVN/trunk/deploy
13
+ # PATCH_DEPLOY_DIR=/path/to/your-php-api/deploy
14
14
 
15
15
  # zip 文件名前缀
16
16
  # PATCH_ZIP_PREFIX=backend-update
package/lib/config.js CHANGED
@@ -23,7 +23,7 @@ function isSvnWorkingCopy (dir) {
23
23
  }
24
24
 
25
25
  /**
26
- * 自动检测 VCS 类型(PHP 后端常见:BackendSVN/trunk 可能 Git+SVN 并存)
26
+ * 自动检测 VCS 类型(PHP 项目可能 Git + SVN 工作副本并存)
27
27
  * @param {string} sourceDir
28
28
  * @returns {'svn'|'git'|null}
29
29
  */
@@ -38,7 +38,7 @@ function detectVcs (sourceDir) {
38
38
  const hasSvn = isSvnWorkingCopy(sourceDir)
39
39
  const hasGit = isGitRepository(sourceDir)
40
40
 
41
- // 双仓库并存时:有 SVN marker / 旧版 rev 文件则优先 SVN(KJCG Backend 场景)
41
+ // 双仓库并存时:有 SVN marker / 旧版 rev 文件则优先 SVN
42
42
  if (hasSvn && hasGit) {
43
43
  if (marker?.vcs === 'svn') return 'svn'
44
44
  const legacyRev = path.join(deployDir, '.last-deploy-rev')
package/lib/marker.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * svn:467
6
6
  * git:abc123def456789...
7
7
  *
8
- * 兼容 KJCG 旧版:若无 marker 则读取 `.last-deploy-rev`(仅 SVN)
8
+ * 兼容旧版工具:若无 marker 则读取 `.last-deploy-rev`(仅 SVN)
9
9
  */
10
10
 
11
11
  const fs = require('fs')
package/lib/svn.js CHANGED
@@ -118,7 +118,7 @@ function normalizeRelativePath (rawPath, sourceDir, svnRoot) {
118
118
  * @returns {DiffEntry[]}
119
119
  */
120
120
  function getSvnDiffSummary ({ sourceDir, fromRev, toRev, svnExe = findSvnExe() }) {
121
- const svnRoot = path.dirname(sourceDir) // 常见 layout: BackendSVN/trunk
121
+ const svnRoot = path.dirname(sourceDir) // 常见 layout: repo-root/trunk
122
122
  const output = runSvn(
123
123
  svnExe,
124
124
  ['diff', '-r', `${fromRev}:${toRev}`, '--summarize', sourceDir],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vcs-patch-deploy",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "PHP 后端(ThinkPHP)增量部署包生成工具 — 支持 SVN revision 与 Git commit 差异对比,打 zip 并附带 apply-update.php,供堡垒机/Web 终端上线",
5
5
  "main": "lib/index.js",
6
6
  "bin": {
@@ -43,6 +43,7 @@
43
43
  "lib/",
44
44
  "assets/",
45
45
  "README.md",
46
+ "CHANGELOG.md",
46
47
  "LICENSE",
47
48
  "env.example"
48
49
  ],