From 42d3a40fadfecc58f2fc0b628064aa667c8384df Mon Sep 17 00:00:00 2001 From: zwjsec Date: Wed, 12 Mar 2025 07:22:56 +0000 Subject: [PATCH] add autoupgrade/readme.md. Signed-off-by: zwjsec --- autoupgrade/readme.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 autoupgrade/readme.md diff --git a/autoupgrade/readme.md b/autoupgrade/readme.md new file mode 100644 index 00000000..b4fde8a6 --- /dev/null +++ b/autoupgrade/readme.md @@ -0,0 +1,31 @@ +# 自动升级配置文件字段说明 +```name``` +- 含义：软件包的名称。 +- 类型：(必选)字符串 +- 示例：perl-Business-ISBN-Data +- 解释：表示该包的名称为 perl-Business-ISBN-Data，通常用于在自动升级系统中标识和引用该包。 + +```upstream_url``` +- 含义：指定该包的上游（原始）资源的 URL 地址。 +- 类型：(必选)字符串 +- 示例：https://metacpan.org/dist/Business-ISBN-Data +- 解释：表示该包的上游资源的网站，可以通过该 URL 访问和获取该包的最新版本号；该字段与regex字段一起使用，填写的url必须要包含有**软件版本信息**。 + +```regex``` +- 含义：用于指定正则表达式（Regular Expression）的匹配规则，以从upstream_url中提取软件版本号。 +- 类型：(必选)字符串 +- 示例：(?:Alluxio\s+)?v(\d+.\d+.\d+) +- 解释： + - `(?:Alluxio\s+)?`：这是一个非捕获组（由于前面的?:），并且它是可选的（由于后面的?）。这意味着括号内的内容可以出现0次或1次。在这个例子中，它用于匹配可能存在的“Alluxio ”前缀（注意后面有一个空格）。由于是非捕获组，所以即使匹配成功，这部分内容也不会被单独捕获或保存。 + - ```Alluxio\s+```：这是非捕获组内的内容。Alluxio是字面量字符串，表示要匹配的文本中包含“Alluxio”。\s+匹配一个或多个空白字符（如空格、制表符等），确保“Alluxio”和后面的“v”版本标识符之间有空格分隔 + - ```(\d+\.\d+\.\d+)```: 这是一个捕获组，用于匹配并捕获具体的版本号。\d+匹配一个或多个数字字符，.在这里是字面量点字符（表示版本号中的分隔符），由于.在正则表达式中有特殊含义（匹配任意单个字符），所以需要使用\进行转义以表示其字面量意义。因此，\d+.\d+.\d+匹配形如1.2.3的版本号，其中每个数字部分至少有一位数字 + +这段正则表达式用于匹配形如“Alluxio 1.2.3”或“v1.2.3”的字符串，并捕获其中的版本号“1.2.3”。如果字符串包含“Alluxio ”前缀，该前缀将被忽略，只有版本号部分被捕获。 + +```auto_upgrade``` +- 含义：控制是否自动升级该包。 +- 类型：(必选)枚举值 取值：enable、disable +- 示例：disable +- 解释： + - ```disable```: 表示禁用了自动升级功能。这意味着该包只会自动从上游资源获取更新版本，并创建ISSUE提醒，不会触发升级操作。 + - ```enable```: 表示启用了自动升级功能。这意味着该包不仅会自动从上游资源获取更新版本，并创建自动升级PR，触发升级操作。 \ No newline at end of file -- Gitee