docs(calculate-version): 補齊 function JSDoc 與指令檔逐行註解並重建 README

2026-06-30 12:42:11 +08:00
parent fe299cac64
commit 7954fda311
6 changed files with 37 additions and 27 deletions
@@ -10,6 +10,8 @@ const fs = require('node:fs');
 * @param {string} [file=process.env.GITHUB_OUTPUT] - 輸出檔路徑，預設取自環境變數 `GITHUB_OUTPUT`。
 * @throws {Error} 當輸出檔路徑為 falsy（例如 `GITHUB_OUTPUT` 未設定）時拋出，無法寫入輸出。
 * @returns {void}
+ * @remarks 由 main 於計算出版本號後呼叫，將 `version` 寫入 Action output 供後續 step 取用；
+ *   以 append 方式寫入、不覆蓋既有內容，且 value 僅支援單行字串（未處理換行或 `=`）。
 */
 function writeOutput(name, value, file = process.env.GITHUB_OUTPUT) {
    if (!file) {