old-docker-actions/release-cleanup
2
0
Fork 0
Code Pull Requests Actions Releases 4 Activity

docs(release-cleanup): 校正 JSDoc 例外說明、刷新指令檔更新時間並重建 README

Browse Source
This commit is contained in:
Jeffery
2026-07-01 09:28:03 +08:00
parent 0ab90be3bb
commit a4fa7fec85
6 changed files with 33 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -18
View File
@@ -1,6 +1,6 @@
# Release Cleanup
> 更新時間：2026/07/01 09:00:53（台灣時區 Asia/Taipei）
> 更新時間：2026/07/01 09:20:52（台灣時區 Asia/Taipei）
清理舊成品的 **Gitea / GitHub docker container action**。依保留數量清理 repo 的舊 release，並刪除沒有對應 release 的 tag；正式版與 beta 版各自獨立保留指定數量。
@@ -13,7 +13,7 @@
2. **取得舊版本**：取得所有 release，依建立時間由新到舊排序，並以 tag 名稱含 `-beta.` 與否分為正式版與 beta 版。
3. **刪除舊版本**：正式版與 beta 版**各自**保留最新 `KEEP_COUNT` 筆，刪除其餘 release（單筆刪除失敗只記錄錯誤，不中斷）；接著重新取得 release 後，刪除所有未被任何 release 指定的 tag。
`GITEA_TOKEN` 為空時以匿名身分呼叫 API。取得分頁失敗或參數不合法則直接以 exit code 1 結束程序。
`GITEA_TOKEN` 為空時以匿名身分呼叫 API。取得分頁失敗或參數不合法則直接以 exit code 1 結束程序；底層 `fetch` 網路錯誤或回應非 JSON 造成的解析失敗會上拋，由檔尾 `main().catch` 統一捕捉後以 exit code 1 結束。
## 日誌輸出格式
@@ -27,10 +27,10 @@
範例：
```text
[參數檢查][INF][2026/07/01 09:00:53]: GITEA_SERVER_URL=https://gitea.jsc.idv.tw
[取得舊版本][INF][2026/07/01 09:00:53]: RELEASE_COUNT=3
[取得舊版本][INF][2026/07/01 09:00:53]: 沒有需要清理的舊版本成品
[刪除舊版本][ERR][2026/07/01 09:00:53]: 刪除 tag 失敗: v0.0.1, HTTP 500
[參數檢查][INF][2026/07/01 09:20:52]: GITEA_SERVER_URL=https://gitea.jsc.idv.tw
[取得舊版本][INF][2026/07/01 09:20:52]: RELEASE_COUNT=3
[取得舊版本][INF][2026/07/01 09:20:52]: 沒有需要清理的舊版本成品
[刪除舊版本][ERR][2026/07/01 09:20:52]: 刪除 tag 失敗: v0.0.1, HTTP 500
```
> 容器啟動橫幅（名稱／用途／更新時間）由 `entrypoint.sh` 輸出，不帶等級與階段前綴。
@@ -83,7 +83,7 @@ jobs:
### release-cleanup
> 說明：本專案為單一 Node 模組（`app/index.js`），下列為模組內可文件化的頂層函式（不含 `main` 內部的巢狀私有函式 `fetchAllPages` / `deleteUrl`）。
> 說明：本專案為單一 Node 模組（`app/index.js`），未 `module.exports` 任何函式，下列為模組內可文件化的頂層函式（不含 `main` 內部的巢狀私有函式 `fetchAllPages` / `deleteUrl`）。
| 功能名稱 | 功能描述 |
| --- | --- |
@@ -110,7 +110,7 @@ jobs:
```js
stage('取得舊版本');
info('RELEASE_COUNT=3');
// 輸出：[取得舊版本][INF][2026/07/01 09:00:53]: RELEASE_COUNT=3
// 輸出：[取得舊版本][INF][2026/07/01 09:20:52]: RELEASE_COUNT=3
```
> 前置條件：無。結果：更新模組層級的目前階段字串；本身不輸出任何內容。
@@ -122,7 +122,7 @@ info('RELEASE_COUNT=3');
```js
timestamp();
// 例如回傳： '2026/07/01 09:00:53'
// 例如回傳： '2026/07/01 09:20:52'
```
> 前置條件：執行環境須支援 `Intl`（Node 18+ 內建）。結果：回傳當下台灣時間字串，無副作用。
@@ -135,7 +135,7 @@ timestamp();
```js
stage('刪除舊版本');
formatLog('ERR', '刪除 tag 失敗: v0.0.1, HTTP 500');
// 回傳： '[刪除舊版本][ERR][2026/07/01 09:00:53]: 刪除 tag 失敗: v0.0.1, HTTP 500'
// 回傳： '[刪除舊版本][ERR][2026/07/01 09:20:52]: 刪除 tag 失敗: v0.0.1, HTTP 500'
```
<a id="info"></a>
@@ -146,7 +146,7 @@ formatLog('ERR', '刪除 tag 失敗: v0.0.1, HTTP 500');
```js
stage('取得舊版本');
info('RELEASE_COUNT=10');
// 輸出：[取得舊版本][INF][2026/07/01 09:00:53]: RELEASE_COUNT=10
// 輸出：[取得舊版本][INF][2026/07/01 09:20:52]: RELEASE_COUNT=10
```
<a id="success"></a>
@@ -157,7 +157,7 @@ info('RELEASE_COUNT=10');
```js
stage('取得舊版本');
success('沒有需要清理的舊版本成品');
// 輸出：[取得舊版本][INF][2026/07/01 09:00:53]: 沒有需要清理的舊版本成品
// 輸出：[取得舊版本][INF][2026/07/01 09:20:52]: 沒有需要清理的舊版本成品
```
<a id="warn"></a>
@@ -168,7 +168,7 @@ success('沒有需要清理的舊版本成品');
```js
stage('參數檢查');
warn('GITEA_TOKEN is empty; release API calls will be anonymous');
// 輸出：[參數檢查][WRN][2026/07/01 09:00:53]: GITEA_TOKEN is empty; release API calls will be anonymous
// 輸出：[參數檢查][WRN][2026/07/01 09:20:52]: GITEA_TOKEN is empty; release API calls will be anonymous
```
<a id="fail"></a>
@@ -179,19 +179,20 @@ warn('GITEA_TOKEN is empty; release API calls will be anonymous');
```js
stage('刪除舊版本');
fail('刪除 tag 失敗: v0.0.1, HTTP 500');
// 輸出（stderr）：[刪除舊版本][ERR][2026/07/01 09:00:53]: 刪除 tag 失敗: v0.0.1, HTTP 500
// 輸出（stderr）：[刪除舊版本][ERR][2026/07/01 09:20:52]: 刪除 tag 失敗: v0.0.1, HTTP 500
process.exit(1); // 終止由呼叫端負責
```
<a id="isemptyornull"></a>
### isEmptyOrNull
判斷值是否視為「空 / 未設定」，涵蓋 `undefined`、`null`、空字串，以及字面字串 `'null'`（用於處理 CI/環境變數把未設定值帶成字串 `"null"` 的情況）。
判斷值是否視為「空 / 未設定」，涵蓋 `undefined`、`null`、空字串，以及字面字串 `'null'`（用於處理 CI/環境變數把未設定值帶成字串 `"null"` 的情況）。以嚴格相等比對，故 `0`、`false`、`'0'`、純空白字串**不**視為空。
```js
isEmptyOrNull(''); // true
isEmptyOrNull('null'); // true（字面字串）
isEmptyOrNull('abc'); // false
isEmptyOrNull('0'); // false（非空字串）
```
<a id="requirevalue"></a>
@@ -210,7 +211,7 @@ requireValue('GITEA_SERVER_URL', process.env.GITEA_SERVER_URL);
<a id="requireinteger"></a>
### requireInteger
驗證值是否為非負整數字串（正則 `/^[0-9]+$/`，允許前導零、不允許負號或小數），不符合時以 `[ERR]` 輸出並以 exit code 1 結束程序。
驗證值是否為非負整數字串（正則 `/^[0-9]+$/`，允許前導零、不允許負號或小數），不符合時以 `[ERR]` 輸出並以 exit code 1 結束程序。本函式不處理空值語意，需搭配 `requireValue` 先攔缺值。
```js
requireInteger('KEEP_COUNT', '2'); // 通過
@@ -220,7 +221,7 @@ requireInteger('KEEP_COUNT', '-1'); // 輸出 [ERR] 訊息並 process.exit(1)
<a id="isbeta"></a>
### isBeta
判斷 release / tag 名稱是否為 beta 版本，規則為名稱中含有子字串 `-beta.`。
判斷 release / tag 名稱是否為 beta 版本，規則為名稱中含有子字串 `-beta.`（區分大小寫）。
```js
isBeta('v1.2.3-beta.1'); // true
@@ -231,7 +232,7 @@ isBeta('v1.2.3-beta'); // false（無結尾的點，不符合 -beta.）
<a id="main"></a>
### main
Action 主流程（`async`）。讀取環境變數後依序執行參數檢查、取得 release、刪除舊版本（正式版與 beta 版各自保留 `KEEP_COUNT` 筆）、刪除未指定 release 的 tag；各階段以 `stage()` 標示，log 皆帶 `[階段]` 前綴。由檔尾 `main().catch(...)` 立即執行。
Action 主流程（`async`）。讀取環境變數後依序執行參數檢查、取得 release、刪除舊版本（正式版與 beta 版各自保留 `KEEP_COUNT` 筆）、刪除未指定 release 的 tag；各階段以 `stage()` 標示，log 皆帶 `[階段]` 前綴。由檔尾 `main().catch(...)` 立即執行並收斂未攔截的例外。
```js
// 容器啟動時由 entrypoint.sh 執行：exec node /app/index.js