docs(calculate-version): 重建 README、修正 compareVersionArrays JSDoc 並更新指令檔註解日期
This commit is contained in:
Jeffery
@@ -2,7 +2,7 @@
|
||||
|
||||
計算版本號的 Gitea Action：依儲存庫現有的 release，推算下一個穩定版或 beta 版本號，並寫出為 Action output 供後續步驟取用。以 Docker 容器執行，容器內由 Node.js 主程式實作。
|
||||
|
||||
> 更新時間：2026/06/30 16:42:27（Asia/Taipei）
|
||||
> 更新時間：2026/06/30 17:38:51（Asia/Taipei）
|
||||
|
||||
## 專案列表
|
||||
|
||||
@@ -40,13 +40,13 @@
|
||||
| [logger.error](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/logger.js#L77) | [輸出 `[ERR][時間]` 格式的錯誤訊息至標準錯誤輸出。](#loggererror) |
|
||||
| [output.writeOutput](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/output.js#L16) | [將一行 `name=value` 附加寫入 Action 的輸出檔。](#outputwriteoutput) |
|
||||
| [releases.fetchReleases](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/releases.js#L24) | [以分頁方式取得指定 Gitea repo 的所有 release。](#releasesfetchreleases) |
|
||||
| [version.compareVersionArrays](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L14) | [逐區段比較兩個版本號數值陣列，較短者視為較小。](#versioncompareversionarrays) |
|
||||
| [version.parseStableVersions](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L38) | [從 release 清單解析出所有穩定版的版本號數值陣列。](#versionparsestableversions) |
|
||||
| [version.latestStableVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L57) | [取得最新（最大）的穩定版版本號字串。](#versionlateststableversion) |
|
||||
| [version.nextReleaseVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L78) | [依最新穩定版計算下一個發行版本號（逢 10 進位）。](#versionnextreleaseversion) |
|
||||
| [version.nextBetaNumber](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L101) | [計算指定版本號的下一個 beta 流水號。](#versionnextbetanumber) |
|
||||
| [version.nextVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L130) | [依已知的最新穩定版計算本次要使用的版本號（含 beta）。](#versionnextversion) |
|
||||
| [version.calculateVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L146) | [計算最新穩定版與下一個版本號。](#versioncalculateversion) |
|
||||
| [version.compareVersionArrays](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L15) | [逐區段比較兩個版本號數值陣列，較短者視為較小。](#versioncompareversionarrays) |
|
||||
| [version.parseStableVersions](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L39) | [從 release 清單解析出所有穩定版的版本號數值陣列。](#versionparsestableversions) |
|
||||
| [version.latestStableVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L58) | [取得最新（最大）的穩定版版本號字串。](#versionlateststableversion) |
|
||||
| [version.nextReleaseVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L79) | [依最新穩定版計算下一個發行版本號（逢 10 進位）。](#versionnextreleaseversion) |
|
||||
| [version.nextBetaNumber](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L102) | [計算指定版本號的下一個 beta 流水號。](#versionnextbetanumber) |
|
||||
| [version.nextVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L131) | [依已知的最新穩定版計算本次要使用的版本號（含 beta）。](#versionnextversion) |
|
||||
| [version.calculateVersion](https://gitea.jsc.idv.tw/docker-actions/calculate-version/src/branch/develop/app/version.js#L147) | [計算最新穩定版與下一個版本號。](#versioncalculateversion) |
|
||||
|
||||
## 使用範例
|
||||
|
||||
@@ -142,7 +142,7 @@ logger.section('參數檢查');
|
||||
const logger = require('./app/logger');
|
||||
|
||||
logger.info('NEW_VERSION=1.2.4');
|
||||
// 輸出：[INF][2026/06/30 16:42:27]: NEW_VERSION=1.2.4
|
||||
// 輸出：[INF][2026/06/30 17:38:51]: NEW_VERSION=1.2.4
|
||||
```
|
||||
|
||||
<a id="loggererror"></a>
|
||||
@@ -154,7 +154,7 @@ logger.info('NEW_VERSION=1.2.4');
|
||||
const logger = require('./app/logger');
|
||||
|
||||
logger.error('GITEA_SERVER_URL 未設定');
|
||||
// stderr 輸出：[ERR][2026/06/30 16:42:27]: GITEA_SERVER_URL 未設定
|
||||
// stderr 輸出：[ERR][2026/06/30 17:38:51]: GITEA_SERVER_URL 未設定
|
||||
```
|
||||
|
||||
<a id="outputwriteoutput"></a>
|
||||
@@ -187,7 +187,7 @@ const releases = await fetchReleases(
|
||||
<a id="versioncompareversionarrays"></a>
|
||||
### version.compareVersionArrays
|
||||
|
||||
逐區段（element-wise）比較兩個版本號數值陣列，較短的陣列視為較小。回傳大於 0 表示 `a` 大於 `b`、小於 0 表示 `a` 小於 `b`、0 表示相等。
|
||||
逐區段（element-wise）比較兩個版本號數值陣列，較短的陣列視為較小。回傳大於 0 表示 `a` 大於 `b`、小於 0 表示 `a` 小於 `b`、0 表示相等；相異區段回傳的是該段差值（非固定 ±1）。傳入 `null`／`undefined` 會在讀取 `.length` 時拋 `TypeError`。
|
||||
|
||||
```js
|
||||
const { compareVersionArrays } = require('./app/version');
|
||||
|
||||
Reference in New Issue
Block a user