diff --git a/.gitea/scoped_workflows/ci.yaml b/.gitea/scoped_workflows/ci.yaml deleted file mode 100644 index 2429008..0000000 --- a/.gitea/scoped_workflows/ci.yaml +++ /dev/null @@ -1,36 +0,0 @@ -name: CI - -on: - pull_request: - branches: - - master - - develop - types: [opened, synchronize] - -env: - REPOSITORY_NAME: ${{ gitea.event.repository.name }} - IS_BETA: ${{ gitea.base_ref == 'develop' }} - -jobs: - build: - name: BUILD - runs-on: ubuntu - steps: - - name: 取得存取庫資訊 (含 Tag) - uses: actions/checkout@${{ vars.ACTION_CHECKOUT_VERSION }} - with: - fetch-depth: 0 - - name: 計算下一個版本號 - uses: https://gitea.jsc.idv.tw/docker-actions/calculate-next-version@${{ vars.ACTION_CALCULATE_NEXT_VERSION }} - id: calculate-next-version - with: - is_beta: ${{ env.IS_BETA }} - - name: 發布成品 - uses: akkuman/gitea-release-action@${{ vars.ACTION_GITEA_RELEASE_VERSION }} - env: - VERSION: ${{ steps.calculate-next-version.outputs.value }} - with: - name: "${{ gitea.event.repository.name }} v${{ env.VERSION }}" - tag_name: "v${{ env.VERSION }}" - target_commitish: "${{ gitea.sha }}" - prerelease: ${{ env.IS_BETA }} diff --git a/action.yml b/action.yml index 1c9e436..08d0e92 100644 --- a/action.yml +++ b/action.yml @@ -1,14 +1,16 @@ -name: 'Gitea Docker Template' -description: 'Gitea Docker 範本' -author: 'Jeffery' +name: Clean Old Release +description: 依建立時間將 release 分為正式版與 beta 版，各自保留最新指定筆數，其餘舊 release 連同對應 git tag 一併刪除。 +author: Jeffery inputs: - message: - description: '輸入訊息' + keep_count: + description: 正式版 release 要保留的最新筆數 required: false - default: 'Hello, World!' -outputs: - message: - description: '輸出訊息' + default: '5' + keep_count_beta: + description: beta 版（tag 名稱含 beta）release 要保留的最新筆數 + required: false + default: '10' runs: using: docker image: dockerfile + entrypoint: /action/entrypoint.sh diff --git a/dockerfile b/dockerfile index 764900f..2361da8 100644 --- a/dockerfile +++ b/dockerfile @@ -1,11 +1,41 @@ -ARG NODE_VERSION=alpine +# syntax=docker/dockerfile:1 +# ============================================================================ +# 用途：建置 Gitea docker action「Clean Old Release」的容器映像；採多階段建置 +# （build 階段整理產物、runtime 階段改用 node:slim 縮小映像）， +# action 執行時由 /action/entrypoint.sh 啟動 Node.js 主程式清理舊 Release。 +# 更新時間：2026/07/16 14:15:41 +# ============================================================================ -FROM node:${NODE_VERSION} +# 1. 參數處理：build 階段 Node 版本以 ARG 注入，預設 latest，可於建置時覆寫 +ARG NODE_VERSION=latest + +# runtime 階段基底標籤，預設 slim 以縮小最終映像體積 +ARG NODE_RUNTIME=slim + +# ---- build 階段：整理產物 ---- +# 以 node:${NODE_VERSION} 作為 build 階段基底並命名為 build，供後續階段引用 +FROM node:${NODE_VERSION} AS build + +# 設定工作目錄為 /action，後續 COPY/RUN 皆以此為基準路徑 WORKDIR /action -COPY src/ /action/ -COPY entrypoint.sh /entrypoint.sh +# 2. 複製檔案：帶入 Node.js 主程式（僅用 Node 內建模組，無相依套件需安裝） +COPY src/ /action/src/ -RUN chmod +x /entrypoint.sh +# 帶入容器入口腳本，負責啟動 node 主程式 +COPY entrypoint.sh /action/entrypoint.sh -ENTRYPOINT ["/entrypoint.sh"] +# 3. 執行程序：賦予 entrypoint 執行權限，否則 runtime 階段無法作為 ENTRYPOINT 執行 +RUN chmod +x /action/entrypoint.sh + +# 4. 縮小映像檔：runtime 改用 node:${NODE_RUNTIME}（slim）基底，只帶必要產物 +FROM node:${NODE_RUNTIME} AS runtime + +# 於 runtime 階段同樣以 /action 為工作目錄，維持與 build 階段一致的路徑 +WORKDIR /action + +# 從 build 階段複製整理好的產物（src/ 與已具執行權限的 entrypoint.sh） +COPY --from=build /action /action + +# 5. 設定入口：容器啟動時以 entrypoint.sh 執行 node 主程式 +ENTRYPOINT ["/action/entrypoint.sh"] diff --git a/entrypoint.sh b/entrypoint.sh old mode 100644 new mode 100755 index 9dcd5e8..fca718b --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,10 +1,25 @@ #!/bin/sh +# ============================================================================ +# 用途：Gitea docker action「Clean Old Release」的容器入口腳本； +# 容器啟動時由 Docker ENTRYPOINT 呼叫，先輸出啟動訊息， +# 再以 exec 啟動 node 主程式 /action/src/index.js 執行清理舊 release 的主要邏輯。 +# 更新時間：2026/07/16 14:15:34 +# ============================================================================ + +# 啟用「任一指令失敗即中止」模式：後續任何指令回傳非零 exit code 時立即結束腳本， +# 避免在啟動階段發生錯誤後仍繼續執行，導致以錯誤狀態啟動主程式 set -e -echo "================================================" -echo "Action : Gitea Docker Template" -echo "用途 : Gitea Docker 範本" -echo "更新時間: 2026/07/02 09:41:31" -echo "================================================" +# 輸出啟動訊息第 1 行：action 名稱，供 CI log 辨識目前執行的 action（此檔由 code-action-docker 產生） +echo "[2026/07/16 14:09:54][啟動][INF]: Action：Clean Old Release" -exec node /action/index.js "$@" +# 輸出啟動訊息第 2 行：action 用途摘要，說明會依建立時間分類並刪除舊 release 與對應 git tag（具刪除副作用，由 node 主程式實際執行） +echo "[2026/07/16 14:09:54][啟動][INF]: 用途：依建立時間將 release 分為正式版與 beta 版，各自保留最新指定筆數，其餘舊 release 連同對應 git tag 一併刪除。" + +# 輸出啟動訊息第 3 行：此入口腳本的產生／更新時間，方便追蹤映像檔內腳本版本 +echo "[2026/07/16 14:09:54][啟動][INF]: 更新時間：2026/07/16 14:09:54" + +# 以 exec 啟動 node 主程式：讓 node 直接取代目前 shell 成為 PID 1， +# 正確接收容器停止訊號（SIGTERM 等）並回傳真實 exit code； +# "$@" 將容器啟動時傳入的所有參數原封不動轉交給 /action/src/index.js +exec node /action/src/index.js "$@" diff --git a/readme.md b/readme.md index 505de76..d55fc8d 100644 --- a/readme.md +++ b/readme.md @@ -1,375 +1,133 @@ -# Gitea Docker Container Action 範本 +# Clean Old Release -Docker container（容器）action 讓你把整個執行環境打包成一個 Docker image：action 在你指定的容器內執行，環境、相依套件、工具版本全部固定，跨機器結果一致。適合需要特定系統套件、編譯環境或非 JavaScript 語言撰寫的 action。 +依建立時間將 release 分為正式版與 beta 版，各自保留最新指定筆數，其餘舊 release 連同對應 git tag 一併刪除。 -本文件整理 Docker container action `action.yml` 中**所有可用參數、說明與限制**，包含 `Dockerfile` 撰寫注意事項，並特別標出 **Gitea 與 GitHub Actions 的差異**。 +- 更新時間：2026/07/16 14:30:31 -> 語法基準：Gitea Actions 以相容 GitHub Actions metadata 語法為目標，但兩者有明確差異（見「Gitea vs GitHub」章節）。Gitea 端的行為亦受底層 [`act`](https://gitea.com/gitea/act) runner 版本影響，實作前建議以測試機驗證。 -> -> ⚠️ **平台限制**：Docker container action **只能在 Linux runner 上執行**，且該 runner 必須安裝 Docker。Windows / macOS runner 不支援。 +## 專案列表 ---- +### 專案描述 -## 目錄 +| 專案名稱 | 專案描述 | +| --- | --- | +| [clean-old-release](https://gitea.jsc.idv.tw/docker-actions/clean-old-release) | Gitea Docker 容器 action：以 Node.js 透過 Gitea API 逐頁取得 repo 全部 release，依 tag 名稱是否含 `beta` 分為正式版與 beta 版兩群，各自依建立時間保留最新指定筆數（`keep_count` 預設 5、`keep_count_beta` 預設 10），其餘舊 release 連同對應 git tag 一併刪除；並提供統一格式（`[yyyy/MM/dd HH:mm:ss][階段][等級]: 訊息`，Asia/Taipei 時區）的 logger 模組。 | -- [完整結構總覽](#完整結構總覽) -- [頂層參數](#頂層參數) -- [`inputs`（輸入參數）](#inputs輸入參數) -- [`outputs`（輸出）](#outputs輸出) -- [`runs`（執行設定）](#runs執行設定) -- [`Dockerfile` 撰寫注意事項](#dockerfile-撰寫注意事項) -- [Docker action 的限制與注意事項](#docker-action-的限制與注意事項) -- [Gitea vs GitHub Actions 差異](#gitea-vs-github-actions-差異) -- [本 repo 範例對照](#本-repo-範例對照) -- [參考來源](#參考來源) +### 參考專案 ---- +| 專案名稱 | 參考專案列表 | +| --- | --- | +| [clean-old-release](https://gitea.jsc.idv.tw/docker-actions/clean-old-release) | 無 | -## 完整結構總覽 +### NuGet 套件 + +| 專案名稱 | NuGet 套件列表 | +| --- | --- | +| [clean-old-release](https://gitea.jsc.idv.tw/docker-actions/clean-old-release) | 無（Node.js 專案，僅使用 Node 內建模組，無外部相依套件） | + +## Action 使用方式 + +### 輸入參數（inputs） + +| 參數 | 必填 | 預設值 | 說明 | +| --- | --- | --- | --- | +| `keep_count` | 否 | `5` | 正式版 release 要保留的最新筆數 | +| `keep_count_beta` | 否 | `10` | beta 版（tag 名稱含 `beta`）release 要保留的最新筆數 | + +### 環境需求 + +執行時依賴 runner 注入的環境變數：`GITHUB_REPOSITORY`（目標 repo）、`GITHUB_API_URL`（或 `GITHUB_SERVER_URL`，用於組出 Gitea API 位址），以及 `GITHUB_TOKEN`／`GITEA_TOKEN`（須具刪除 release 與 tag 的權限）。若 runner 未自動注入 token，請在 workflow 以 `env` 傳入，機敏值不要寫死在檔案中。 + +### workflow 範例 ```yaml -name: 'Gitea Docker Template' # 必填 -description: 'Gitea Docker 範本' # 必填 -author: 'Jeffery' # 選填 - -inputs: # 選填，定義輸入參數 - message: - description: '輸入訊息' - required: false - default: 'Hello, World!' - -outputs: # 選填，定義輸出（docker action 只宣告，不用 value） - message: - description: '輸出訊息' - -runs: # 必填 - using: 'docker' # 必填，固定為 docker - image: 'Dockerfile' # 必填，本機 Dockerfile 或 docker://image - # entrypoint: '/entrypoint.sh' # 選填，覆寫 Dockerfile 的 ENTRYPOINT - # pre-entrypoint: '/setup.sh' # 選填，主程式前執行（另開容器） - # post-entrypoint: '/cleanup.sh' # 選填，主程式後執行（另開容器） - env: # 選填，容器內環境變數 - GREETING: ${{ inputs.message }} - args: # 選填，傳給 ENTRYPOINT 的參數（取代 CMD） - - ${{ inputs.message }} - -branding: # 選填（Marketplace 用，Gitea 內部可省略） - icon: 'activity' - color: 'blue' +jobs: + clean: + runs-on: ubuntu + steps: + - name: 清除舊版 release + uses: https://gitea.jsc.idv.tw/docker-actions/clean-old-release@v1 + env: + GITHUB_TOKEN: ${{ gitea.token }} + with: + keep_count: 5 + keep_count_beta: 10 ``` -> 📌 `action.yml`（或 `action.yaml`）放在 action repo 根目錄；`image: 'Dockerfile'` 時，`Dockerfile` 也放在同一目錄。 +## 功能列表 ---- +### clean-old-release -## 頂層參數 +| 功能名稱 | 功能描述 | +| --- | --- | +| [logger.inf](https://gitea.jsc.idv.tw/docker-actions/clean-old-release/src/branch/master/src/logger.js#L54) | [輸出 INF（一般資訊）等級訊息至 stdout](#loggerinf) | +| [logger.wrn](https://gitea.jsc.idv.tw/docker-actions/clean-old-release/src/branch/master/src/logger.js#L60) | [輸出 WRN（警告）等級訊息至 stdout](#loggerwrn) | +| [logger.err](https://gitea.jsc.idv.tw/docker-actions/clean-old-release/src/branch/master/src/logger.js#L66) | [輸出 ERR（錯誤）等級訊息至 stderr](#loggererr) | +| [logger.trc](https://gitea.jsc.idv.tw/docker-actions/clean-old-release/src/branch/master/src/logger.js#L72) | [輸出 TRC（細部追蹤）等級訊息至 stdout](#loggertrc) | +| [logger.dbg](https://gitea.jsc.idv.tw/docker-actions/clean-old-release/src/branch/master/src/logger.js#L78) | [輸出 DBG（除錯）等級訊息至 stdout](#loggerdbg) | -| 參數 | 必填 | 說明 | -|------|------|------| -| `name` | ✅ | Action 名稱。 | -| `description` | ✅ | Action 簡短說明。 | -| `author` | ❌ | 作者名稱。 | -| `inputs` | ❌ | 輸入參數定義（見下）。 | -| `outputs` | ❌ | 輸出定義（見下）。 | -| `runs` | ✅ | 執行設定；docker 固定用 `using: 'docker'` + `image`。 | -| `branding` | ❌ | Marketplace 顯示用的 `icon` 與 `color`（`color` 限 `white`/`black`/`yellow`/`blue`/`green`/`orange`/`red`/`purple`/`gray-dark`；`icon` 為 Feather 圖示名稱）。 | +備註：`src/index.js` 的主流程函式（`main`、`fetchAllReleases`、`deleteRelease` 等）皆為模組私有、未匯出，依規範不列入功能列表。 ---- +## 使用範例 -## `inputs`（輸入參數） + +### logger.inf -每個 input 是 `inputs.` 底下的一組設定： +輸出 INF（一般資訊）等級訊息至 stdout。訊息格式為 `[yyyy/MM/dd HH:mm:ss][階段][INF]: 訊息`（時間為 Asia/Taipei 時區）；未提供 `stage` 時省略 `[階段]` 區塊。用於記錄流程正常進展，例如讀到的輸入、每個關鍵步驟的結果。 -| 欄位 | 必填 | 說明 | -|------|------|------| -| `description` | ✅ | 參數說明。 | -| `required` | ❌ | 是否必填，布林值，預設 `false`。 | -| `default` | ❌ | 預設值；呼叫端沒傳時採用。**只能是字串**。 | -| `deprecationMessage` | ❌ | 標記此 input 已棄用，使用時發出警告訊息。 | +```js +const logger = require('./logger'); -### Docker action 怎麼取用 input +logger.inf('共取得 12 筆 release', '查詢 release'); +// [2026/07/16 14:30:31][查詢 release][INF]: 共取得 12 筆 release -這是 Docker action **與 composite action 最大的差異**。GitHub / Gitea 會把每個 input 轉成環境變數 `INPUT_`： - -- 名稱轉大寫、空白換成底線。例：input `octocat-eye-color` → 環境變數 `INPUT_OCTOCAT_EYE_COLOR`。 -- input `message` → `INPUT_MESSAGE`。 - -```yaml -inputs: - message: - description: '輸入訊息' - required: false - default: 'Hello, World!' +logger.inf('開始執行 Clean Old Release'); +// [2026/07/16 14:30:31][INF]: 開始執行 Clean Old Release ``` -容器內就能直接讀： + +### logger.wrn -```sh -echo "$INPUT_MESSAGE" +輸出 WRN（警告）等級訊息至 stdout，用於「可繼續執行但需要注意」的異常狀況，例如 tag 已不存在而略過刪除、環境變數改用備援來源推得。 + +```js +const logger = require('./logger'); + +logger.wrn('tag v1.0.0 不存在（可能已被刪除），略過', '刪除'); +// [2026/07/16 14:30:31][刪除][WRN]: tag v1.0.0 不存在（可能已被刪除），略過 ``` -> ⚠️ **關鍵限制**：`INPUT_*` 環境變數**只在 GitHub 官方 runner 保證自動注入**。若要跨環境（尤其 Gitea/`act`）可靠取值，官方建議**用 `args` 明確把 input 傳進容器**，或在 `runs.env` 自行對應一次（見下方 `runs.env`）。不要單靠 `INPUT_*` 而不驗證。 + +### logger.err -**呼叫端傳值**（用 `with`）： +輸出 ERR（錯誤）等級訊息至 stderr（`console.error`），用於記錄失敗狀況；訊息輸出後通常由呼叫端決定是否以非零 exit code 結束程序（logger 本身不會終止程序）。 -```yaml -- uses: ./ - with: - message: 'Hi there' +```js +const logger = require('./logger'); + +logger.err('刪除 release v1.0.0 失敗：HTTP 403 Forbidden', '刪除'); +// [2026/07/16 14:30:31][刪除][ERR]: 刪除 release v1.0.0 失敗：HTTP 403 Forbidden ``` -> input 值一律是**字串**；數字、布林傳進來也會變字串（例如 `"true"`），比較時要留意。 + +### logger.trc ---- +輸出 TRC（細部追蹤）等級訊息至 stdout，用於記錄執行細節（例如每一次 API 呼叫的方法與 URL），方便追蹤問題時還原完整過程。 -## `outputs`（輸出） +```js +const logger = require('./logger'); -Docker action 的 output **只需宣告 `description`**，**不用**（也不能）像 composite 那樣寫 `value`： - -| 欄位 | 必填 | 說明 | -|------|------|------| -| `description` | ✅ | 輸出說明。 | - -**在容器內設定 output** → 寫入 `$GITHUB_OUTPUT` 檔案（該檔案路徑由 runner 掛載進容器）： - -```yaml -outputs: - message: - description: '輸出訊息' +logger.trc('GET https://gitea.example.com/api/v1/repos/owner/repo/releases?page=1&limit=50', '呼叫 API'); +// [2026/07/16 14:30:31][呼叫 API][TRC]: GET https://gitea.example.com/api/v1/repos/owner/repo/releases?page=1&limit=50 ``` -`entrypoint.sh` 內： + +### logger.dbg -```sh -echo "message=Hello from docker" >> "$GITHUB_OUTPUT" +輸出 DBG（除錯）等級訊息至 stdout，用於開發階段的除錯資訊，例如列出各群組實際保留了哪些 release。 + +```js +const logger = require('./logger'); + +logger.dbg('正式版保留：v2.3.0（建立於 2026-07-01T10:00:00Z）', '分群'); +// [2026/07/16 14:30:31][分群][DBG]: 正式版保留：v2.3.0（建立於 2026-07-01T10:00:00Z） ``` - -**呼叫端取用 output**： - -```yaml -- id: docker-template - uses: ./ -- run: echo "${{ steps.docker-template.outputs.message }}" -``` - -> 📦 output 大小限制：單一 job 的 output 上限 **1 MB**，整個 workflow run 所有 output 合計上限 **50 MB**。 - ---- - -## `runs`（執行設定） - -Docker action 的核心。`using` 固定為 `docker`，其餘欄位： - -| 欄位 | 必填 | 說明 | -|------|------|------| -| `using` | ✅ | 固定為 `'docker'`。 | -| `image` | ✅ | 要跑的 image：本機 `Dockerfile`（檔名必須正好是 `Dockerfile`），或遠端 image 用 `docker://` 前綴（如 `docker://alpine:3.20`、`docker://gcr.io/...`）。 | -| `entrypoint` | ❌ | 覆寫 Dockerfile 的 `ENTRYPOINT`；Dockerfile 沒設時等於補上。建議用絕對路徑（如 `/entrypoint.sh`）。 | -| `pre-entrypoint` | ❌ | 在主 `entrypoint` **之前**執行的前置腳本。**會另開一個新容器**（同 base image），runtime 狀態與主容器不同——需保留的狀態要放進 workspace、`HOME`，或用 `STATE_` 變數傳遞。 | -| `post-entrypoint` | ❌ | 主 `entrypoint` 完成後執行的清理腳本，行為同 `pre-entrypoint`（另開容器）。 | -| `pre-if` | ❌ | 條件式，控制 `pre-entrypoint` 是否執行；預設一定跑。 | -| `post-if` | ❌ | 條件式，控制 `post-entrypoint` 是否執行；預設一定跑。 | -| `args` | ❌ | 字串陣列，啟動時傳給容器 `ENTRYPOINT` 的參數，**取代 Dockerfile 的 `CMD`**。 | -| `env` | ❌ | key/value map，容器啟動時設定的環境變數。 | - -### `image`：Dockerfile vs 遠端 image - -```yaml -# 用本機 Dockerfile（每次執行前會 build） -runs: - using: 'docker' - image: 'Dockerfile' - -# 直接拉遠端 image（不用自帶 Dockerfile，啟動快） -runs: - using: 'docker' - image: 'docker://alpine:3.20' -``` - -### `args`：怎麼把值送進容器 - -`args` 取代 `CMD`，會被當作參數接在 `ENTRYPOINT` 後面： - -```yaml -runs: - using: 'docker' - image: 'Dockerfile' - args: - - ${{ inputs.message }} # → entrypoint.sh 的 $1 - - 'foo' # → $2 - - 'bar' # → $3 -``` - -> ⚠️ 若 `args` 裡放的是**環境變數字串**（如 `- $GREETING`），在 exec-form 的 `ENTRYPOINT` **不會被展開**。要展開變數，讓 entrypoint 走一層 shell（`sh -c`），或改用 `runs.env` 傳值（見下）。 - -### `env`：明確傳環境變數（推薦） - -比起依賴 `INPUT_*` 自動注入，用 `runs.env` 把 input 對應成自訂環境變數，跨環境最穩： - -```yaml -runs: - using: 'docker' - image: 'Dockerfile' - env: - GREETING: ${{ inputs.message }} -``` - -容器內直接 `echo "$GREETING"`。 - ---- - -## `Dockerfile` 撰寫注意事項 - -Docker action 的 `Dockerfile` 有幾條**強制或強烈建議**的規則，踩到會直接失敗或讀不到檔案： - -1. **`FROM` 必須是第一行** - 建議用官方 image + 明確版本標籤（如 `python:3.12-slim`），別用 `latest`；Debian/Alpine 系列較穩。 - -2. **不要用 `USER`** - Docker action **必須以預設的 root 執行**。加了 `USER` 會導致**無法存取 `GITHUB_WORKSPACE`**（掛載進來的 repo 目錄）。 - -3. **不要用 `WORKDIR` 指定 entrypoint 位置** - runner 會自動把 `GITHUB_WORKSPACE` 掛載上來並設為工作目錄（路徑放在 `$GITHUB_WORKSPACE` 環境變數）。`entrypoint`／腳本一律用**絕對路徑**（如 `/entrypoint.sh`），不要依賴 `WORKDIR`。 - -4. **`ENTRYPOINT` 用 exec form（JSON 陣列）** - Docker 官方建議寫 `ENTRYPOINT ["/entrypoint.sh"]`。 - - **exec form**：`args` 能正確以獨立參數傳入，但**不做環境變數展開**（`ENTRYPOINT ["echo", "$GITHUB_SHA"]` 印出的是字面字串）。 - - **shell form**：`ENTRYPOINT /entrypoint.sh` 會走 shell，可展開變數，但 `args` 傳遞行為不同。 - - 需要在 entrypoint 展開變數時，用 `ENTRYPOINT ["sh", "-c", "echo $GITHUB_SHA"]`，或寫一支 `entrypoint.sh` 腳本自行處理。 - -5. **`CMD` 會被 `args` 蓋掉** - `action.yml` 的 `args` 取代 `CMD`。若 action 允許不帶 `args` 也能跑，就在 `Dockerfile` 的 `CMD` 提供預設值，並在 README 說明必要參數。 - -6. **`entrypoint.sh` 腳本規範** - - 開頭要有 shebang：`#!/bin/sh`（或 `#!/bin/bash`，視 base image 而定）。 - - 要可執行：`chmod +x entrypoint.sh`（並在 git 中保留執行權限）。 - - 腳本會收到 `action.yml` 的 `args` 作為位置參數（`$1`, `$2`, …）。 - ---- - -## Docker action 的限制與注意事項 - -以下是實務上最容易踩雷的地方： - -1. **只能跑在 Linux runner，且要有 Docker** - Windows / macOS runner 一律不支援 Docker container action。 - -2. **`INPUT_*` 不保證可靠，優先用 `args` / `env`** - GitHub 官方 runner 會自動注入 `INPUT_`，但這在自架 / Gitea 環境未必成立。要穩定取 input，用 `args` 傳位置參數，或 `runs.env` 對應成自訂環境變數。 - -3. **`pre-entrypoint` / `post-entrypoint` 是「另開容器」** - 它們**不共用主 entrypoint 容器的 runtime 狀態**（不是同一個容器內的前後腳本）。要跨階段保留狀態，寫進 `GITHUB_WORKSPACE`、`HOME`，或用 `STATE_` 變數。 - -4. **本機 `image: 'Dockerfile'` 每次會 build** - 用本機 Dockerfile 時，執行前會先 build image，較慢；想加速可改用 `docker://` 拉預先建好的 image。 - -5. **只有 `GITHUB_WORKSPACE` 是持久且共用的** - 容器內對檔案系統的改動，通常只有掛載進來的 `GITHUB_WORKSPACE` 會被後續 step 看到；其他路徑（如 `/tmp`）在跨 step / 跨 action 時不保證保留。 - -6. **exec-form `ENTRYPOINT` 不展開變數** - 如上「Dockerfile 注意事項」第 4 點，需要展開就走 `sh -c` 或 entrypoint 腳本。 - -7. **`args` 是字串陣列，順序即位置參數** - `args` 的順序對應 entrypoint 的 `$1`, `$2`…；輸入值全是字串。 - -8. **不支援 `runs.steps`** - 那是 composite action 專屬。Docker action 只有一個容器進入點（`entrypoint`）＋選配的 pre/post。 - ---- - -## Gitea vs GitHub Actions 差異 - -Gitea Actions **不是** GitHub Actions 的 100% 複製品。撰寫 Docker action 時特別注意： - -| 項目 | Gitea 行為 | -|------|-----------| -| **runner 需求** | 執行 Docker action 的 `act_runner` 主機必須裝 Docker，且 runner label 對應到支援容器的環境。`runs-on` 只接受 `runs-on: xyz` 或 `runs-on: [xyz]`，不支援複雜表達式。 | -| **`pre-entrypoint` / `post-entrypoint`** | ⚠️ 早期 `act` 版本**完全不執行** pre/post-entrypoint（見 [`nektos/act#2363`](https://github.com/nektos/act/issues/2363)，已於 PR #2394 修復）。Gitea 內建的 `act` 版本若較舊可能仍無效——**使用前務必在測試機驗證**。 | -| **`INPUT_*` 注入** | 是否自動注入 `INPUT_` 取決於 runner 版本，別假設一定有；優先用 `args` / `env` 明確傳值。 | -| **表達式函式** | 依官方比較文件，**僅保證支援 `always()`**；`success()` / `failure()` / `cancelled()` / `hashFiles()` 等視 `act` runner 版本而定，寫 `if:`（含 `pre-if` / `post-if`）前先在測試機驗證。 | -| **`uses` 支援絕對 URL** | 可寫 `uses: https://github.com/owner/repo@v1` 或 `uses: http://your_gitea/owner/repo@branch`，不限同站 action。 | -| **Go actions** | Gitea 額外支援 `using: 'go'` 寫 Go action（GitHub 沒有）；`docker` / `node` / `composite` 皆支援。 | -| **context 檢查較寬鬆** | Gitea 不檢查 context 可用性，`env` context 可用在比 GitHub 更多的位置（但不代表可攜，跨到 GitHub 會失敗）。 | -| **被忽略的 job 欄位** | `jobs..timeout-minutes`、`jobs..continue-on-error`、`jobs..environment` 會被忽略。 | -| **annotations / problem matchers** | 不支援，會被忽略。 | -| **`permissions` scope** | 支援 `permissions`，但沒有 GitHub 專屬的 `statuses` / `checks` / `deployments` / `id-token` / `security-events` / `pages`；Gitea 有自己的 `code` / `releases` / `wiki` / `projects`。 | - -> 上表以 Gitea 官方文件為準；`act` runner 持續更新，部分限制（尤其表達式函式與 pre/post-entrypoint）可能隨版本放寬，仍以你環境的實測為準。 - ---- - -## 本 repo 範例對照 - -一個典型 Docker container action 由三個檔案組成，放在 repo 根目錄： - -**1. `action.yml`** — action 定義 - -```yaml -name: 'Gitea Docker Template' -description: 'Gitea Docker 範本' -author: 'Jeffery' -inputs: - message: - description: '輸入訊息' - required: false - default: 'Hello, World!' -outputs: - message: - description: '輸出訊息' -runs: - using: 'docker' - image: 'Dockerfile' - args: - - ${{ inputs.message }} -``` - -**2. `Dockerfile`** — 執行環境 - -```dockerfile -FROM alpine:3.20 - -COPY entrypoint.sh /entrypoint.sh -RUN chmod +x /entrypoint.sh - -ENTRYPOINT ["/entrypoint.sh"] -``` - -**3. `entrypoint.sh`** — 主程式 - -```sh -#!/bin/sh -set -e - -# $1 來自 action.yml 的 args（呼叫端 with.message） -MESSAGE="$1" - -echo "Docker action 收到訊息：$MESSAGE" - -# 設定 output 供後續 step 使用 -echo "message=$MESSAGE" >> "$GITHUB_OUTPUT" -``` - -**呼叫端**（workflow）用法： - -```yaml -- name: 3. Testing - id: docker-template - uses: ./ - with: - message: 'Hi there' -- name: 4. Feedback - run: echo "${{ steps.docker-template.outputs.message }}" -``` - -> ℹ️ 本 repo 目前的 [`action.yml`](./action.yml) 仍為 composite 範本；要改為 Docker action，依上方三件套調整 `action.yml` 並新增 `Dockerfile`、`entrypoint.sh`。 - ---- - -## 參考來源 - -- [GitHub Actions — Metadata syntax for actions](https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax) -- [GitHub Actions — Dockerfile support for GitHub Actions](https://docs.github.com/en/actions/sharing-automations/creating-actions/dockerfile-support-for-github-actions) -- [GitHub Actions — Creating a Docker container action](https://docs.github.com/en/actions/tutorials/creating-a-docker-container-action) -- [Gitea — Compared to GitHub Actions](https://docs.gitea.com/usage/actions/comparison) -- [Gitea — Actions FAQ](https://docs.gitea.com/usage/actions/faq) -- [nektos/act#2363 — pre/post-entrypoint of Docker actions not executed](https://github.com/nektos/act/issues/2363) diff --git a/src/index.js b/src/index.js index 3727edc..a70f11b 100644 --- a/src/index.js +++ b/src/index.js @@ -1,15 +1,223 @@ -const fs = require('fs'); +/** + * Clean Old Release 主程式： + * 依建立時間將 release 分為正式版與 beta 版（tag 名稱含 beta）， + * 各自保留最新指定筆數，其餘舊 release 連同對應 git tag 一併刪除。 + */ -function main() { - const message = process.env.INPUT_MESSAGE || ''; - const outputPath = process.env.GITHUB_OUTPUT; - const line = `message=${message}\n`; +const logger = require('./logger'); - if (outputPath) { - fs.appendFileSync(outputPath, line); - } else { - process.stdout.write(line); +// 未捕捉例外一律以 ERR 格式輸出後非零結束 +process.on('uncaughtException', (error) => { + logger.err(`未捕捉例外：${error.stack || error.message}`); + process.exit(1); +}); +process.on('unhandledRejection', (reason) => { + logger.err(`未處理的 Promise 拒絕：${reason instanceof Error ? reason.stack : reason}`); + process.exit(1); +}); + +/** + * 讀取並驗證保留筆數輸入（須為 0 以上整數）；未提供時採用預設值， + * 驗證失敗會輸出 ERR 訊息並以 exit code 1 終止程序（不拋出例外）。 + * @param {string} name 輸入參數名稱（log 顯示用） + * @param {string|undefined} raw 環境變數原始值（INPUT_*）；undefined 或空字串視為未提供 + * @param {number} fallback 未提供時的預設值（本身不做驗證，呼叫端須傳入合法值） + * @returns {number} 驗證後的保留筆數（0 為合法值，代表該群全部刪除） + */ +function parseKeepCount(name, raw, fallback) { + if (raw === undefined || raw === '') { + logger.inf(`輸入 ${name} 未提供，採用預設值 ${fallback}`, '讀取輸入'); + return fallback; } + const value = Number(raw); + if (!Number.isInteger(value) || value < 0) { + logger.err(`輸入 ${name} 的值「${raw}」不是 0 以上的整數`, '讀取輸入'); + process.exit(1); + } + logger.inf(`輸入 ${name} = ${value}`, '讀取輸入'); + return value; +} + +/** + * 讀取執行所需的環境設定（repo、API URL、token），任一缺漏即輸出 ERR 並以 exit code 1 結束。 + * repo 取自 GITHUB_REPOSITORY；API URL 優先取 GITHUB_API_URL，否則由 GITHUB_SERVER_URL 推得 /api/v1； + * token 依序取 GITHUB_TOKEN、GITEA_TOKEN，內容不輸出至 log。 + * @returns {{repository: string, apiUrl: string, token: string}} 環境設定；apiUrl 已去除尾端斜線 + */ +function readEnvironment() { + const repository = process.env.GITHUB_REPOSITORY; + if (!repository) { + logger.err('找不到環境變數 GITHUB_REPOSITORY，無法判斷目標 repo', '讀取輸入'); + process.exit(1); + } + + let apiUrl = process.env.GITHUB_API_URL; + if (!apiUrl && process.env.GITHUB_SERVER_URL) { + apiUrl = `${process.env.GITHUB_SERVER_URL.replace(/\/+$/, '')}/api/v1`; + logger.wrn(`環境變數 GITHUB_API_URL 未提供，改由 GITHUB_SERVER_URL 推得：${apiUrl}`, '讀取輸入'); + } + if (!apiUrl) { + logger.err('找不到環境變數 GITHUB_API_URL 或 GITHUB_SERVER_URL，無法組出 Gitea API 位址', '讀取輸入'); + process.exit(1); + } + apiUrl = apiUrl.replace(/\/+$/, ''); + + const token = process.env.GITHUB_TOKEN || process.env.GITEA_TOKEN; + if (!token) { + logger.err('找不到環境變數 GITHUB_TOKEN／GITEA_TOKEN，請於 workflow 以 env 傳入（例如 GITHUB_TOKEN: ${{ gitea.token }}）', '讀取輸入'); + process.exit(1); + } + + logger.inf(`目標 repo：${repository}`, '讀取輸入'); + logger.inf(`Gitea API 位址：${apiUrl}`, '讀取輸入'); + logger.inf('已取得 API token（內容不輸出）', '讀取輸入'); + return { repository, apiUrl, token }; +} + +/** + * 呼叫 Gitea API：組合 URL、附加 token 認證標頭後發出請求。 + * 不檢查 HTTP 狀態碼，一律回傳整包 Response 由呼叫端判斷； + * 網路層例外（連線失敗等）不在此攔截，會沿 Promise 鏈向外拋。 + * @param {{apiUrl: string, token: string}} env 環境設定（readEnvironment() 的回傳值） + * @param {string} method HTTP 方法（如 GET、DELETE） + * @param {string} path API 路徑（/repos/... 開頭，須自行完成 URL 編碼） + * @returns {Promise} fetch 回應 + */ +async function callApi(env, method, path) { + const url = `${env.apiUrl}${path}`; + logger.trc(`${method} ${url}`, '呼叫 API'); + return fetch(url, { + method, + headers: { + Authorization: `token ${env.token}`, + 'Content-Type': 'application/json', + }, + }); +} + +/** + * 逐頁（每頁 50 筆）取得 repo 全部 release，直到單頁回傳不足 50 筆為止； + * 任一頁查詢失敗即輸出 ERR 並以 exit code 1 終止（fail-fast，不做部分清理）。 + * @param {{repository: string, apiUrl: string, token: string}} env 環境設定（readEnvironment() 的回傳值） + * @returns {Promise>} release 清單（僅列出實際使用的欄位，API 回傳物件另有其他欄位） + */ +async function fetchAllReleases(env) { + const releases = []; + const pageSize = 50; + for (let page = 1; ; page += 1) { + const response = await callApi(env, 'GET', `/repos/${env.repository}/releases?page=${page}&limit=${pageSize}`); + if (!response.ok) { + logger.err(`查詢 release 失敗（第 ${page} 頁）：HTTP ${response.status} ${await response.text()}`, '查詢 release'); + process.exit(1); + } + const batch = await response.json(); + logger.trc(`第 ${page} 頁取得 ${batch.length} 筆 release`, '查詢 release'); + releases.push(...batch); + if (batch.length < pageSize) { + break; + } + } + logger.inf(`共取得 ${releases.length} 筆 release`, '查詢 release'); + return releases; +} + +/** + * 依保留筆數挑出某群組要刪除的舊 release（依 created_at 新→舊排序後保留前 N 筆）。 + * 不修改傳入的陣列（排序作用於複本），僅輸出 log，無其他副作用。 + * @param {string} groupName 群組名稱（log 顯示用，如「正式版」「beta 版」） + * @param {Array<{id: number, tag_name: string, created_at: string}>} releases 該群組的 release 清單 + * @param {number} keepCount 要保留的最新筆數；大於清單長度時不刪除任何項目 + * @returns {Array<{id: number, tag_name: string, created_at: string}>} 要刪除的 release 清單（新→舊排序） + */ +function pickDeletions(groupName, releases, keepCount) { + const sorted = [...releases].sort((a, b) => new Date(b.created_at) - new Date(a.created_at)); + const kept = sorted.slice(0, keepCount); + const toDelete = sorted.slice(keepCount); + logger.inf(`${groupName}共 ${sorted.length} 筆，保留最新 ${kept.length} 筆，待刪除 ${toDelete.length} 筆`, '分群'); + for (const release of kept) { + logger.dbg(`${groupName}保留：${release.tag_name}（建立於 ${release.created_at}）`, '分群'); + } + return toDelete; +} + +/** + * 透過 Gitea API 刪除一筆 release，成功後再刪除其對應的 git tag； + * tag 已不存在（404）視為成功並輸出警告，其餘任一步失敗即記錄 ERR 並回報失敗。 + * 注意：release 刪除成功但 tag 刪除失敗時屬部分完成，殘留 tag 需人工清理。 + * @param {{repository: string, apiUrl: string, token: string}} env 環境設定（readEnvironment() 的回傳值，token 須具刪除 release／tag 權限） + * @param {{id: number, tag_name: string, created_at: string}} release 要刪除的 release；tag_name 由本函式做 URL 編碼，呼叫端不需預先編碼 + * @returns {Promise} release 與 tag 皆刪除成功（或 tag 已不存在）為 true；任一 DELETE 非 2xx（tag 404 除外）為 false。HTTP 錯誤不拋例外，網路層例外會向外拋 + */ +async function deleteRelease(env, release) { + logger.inf(`刪除 release：${release.tag_name}（id=${release.id}，建立於 ${release.created_at}）`, '刪除'); + + const releaseResponse = await callApi(env, 'DELETE', `/repos/${env.repository}/releases/${release.id}`); + if (!releaseResponse.ok) { + logger.err(`刪除 release ${release.tag_name} 失敗：HTTP ${releaseResponse.status} ${await releaseResponse.text()}`, '刪除'); + return false; + } + logger.inf(`release ${release.tag_name} 已刪除`, '刪除'); + + const tagResponse = await callApi(env, 'DELETE', `/repos/${env.repository}/tags/${encodeURIComponent(release.tag_name)}`); + if (tagResponse.status === 404) { + logger.wrn(`tag ${release.tag_name} 不存在（可能已被刪除），略過`, '刪除'); + return true; + } + if (!tagResponse.ok) { + logger.err(`刪除 tag ${release.tag_name} 失敗：HTTP ${tagResponse.status} ${await tagResponse.text()}`, '刪除'); + return false; + } + logger.inf(`tag ${release.tag_name} 已刪除`, '刪除'); + return true; +} + +/** + * 主流程：讀取輸入 → 逐頁查詢 release → 以 tag 名稱含 beta 分群 → 依保留筆數挑選待刪 → 逐筆循序刪除 → 總結。 + * 無 release 或兩群皆在保留筆數內時提前結束；任一筆刪除失敗仍繼續刪其餘，最後以 exit code 1 結束。 + * 前置條件：runner 須注入 GITHUB_REPOSITORY 與 GITHUB_API_URL（或 GITHUB_SERVER_URL），並提供 GITHUB_TOKEN／GITEA_TOKEN。 + */ +async function main() { + logger.inf('開始執行 Clean Old Release'); + + const keepCount = parseKeepCount('keep_count', process.env.INPUT_KEEP_COUNT, 5); + const keepCountBeta = parseKeepCount('keep_count_beta', process.env.INPUT_KEEP_COUNT_BETA, 10); + const env = readEnvironment(); + + const releases = await fetchAllReleases(env); + if (releases.length === 0) { + logger.inf('repo 沒有任何 release，無需清理', '完成'); + return; + } + + const betaReleases = []; + const stableReleases = []; + for (const release of releases) { + (release.tag_name.toLowerCase().includes('beta') ? betaReleases : stableReleases).push(release); + } + logger.inf(`分群結果：正式版 ${stableReleases.length} 筆、beta 版 ${betaReleases.length} 筆`, '分群'); + + const toDelete = [ + ...pickDeletions('正式版', stableReleases, keepCount), + ...pickDeletions('beta 版', betaReleases, keepCountBeta), + ]; + if (toDelete.length === 0) { + logger.inf('兩群皆在保留筆數內，無需刪除任何 release', '完成'); + return; + } + + let failureCount = 0; + for (const release of toDelete) { + const success = await deleteRelease(env, release); + if (!success) { + failureCount += 1; + } + } + + if (failureCount > 0) { + logger.err(`清理完成，但有 ${failureCount}/${toDelete.length} 筆刪除失敗`, '完成'); + process.exit(1); + } + logger.inf(`清理完成，共刪除 ${toDelete.length} 筆舊 release（含對應 tag）`, '完成'); } main(); diff --git a/src/logger.js b/src/logger.js new file mode 100644 index 0000000..094b78e --- /dev/null +++ b/src/logger.js @@ -0,0 +1,79 @@ +/** + * 共用 logger：統一輸出格式為 [yyyy/MM/dd HH:mm:ss][階段][等級]: 訊息 + * 無階段時為 [yyyy/MM/dd HH:mm:ss][等級]: 訊息；時間為台灣時區（Asia/Taipei）。 + */ + +const TAIPEI_FORMATTER = new Intl.DateTimeFormat('en-US', { + timeZone: 'Asia/Taipei', + year: 'numeric', + month: '2-digit', + day: '2-digit', + hour: '2-digit', + minute: '2-digit', + second: '2-digit', + hour12: false, +}); + +/** + * 取得目前台灣時區時間字串（yyyy/MM/dd HH:mm:ss）； + * 以 Intl.DateTimeFormat 的 formatToParts 組字串，不受系統時區影響。 + * @returns {string} 台灣時區（Asia/Taipei）的當下時間，固定 yyyy/MM/dd HH:mm:ss 格式 + */ +function timestamp() { + const parts = {}; + for (const { type, value } of TAIPEI_FORMATTER.formatToParts(new Date())) { + parts[type] = value; + } + // hour12: false 在部分環境會把 00 顯示成 24，統一正規化 + const hour = parts.hour === '24' ? '00' : parts.hour; + return `${parts.year}/${parts.month}/${parts.day} ${hour}:${parts.minute}:${parts.second}`; +} + +/** + * 組合訊息前綴並輸出一行訊息。 + * @param {string} level 等級（INF/WRN/ERR/TRC/DBG） + * @param {string} message 訊息內容 + * @param {string} [stage] 階段名稱；未提供時省略 [階段] 區塊 + */ +function write(level, message, stage) { + const prefix = stage ? `[${timestamp()}][${stage}][${level}]` : `[${timestamp()}][${level}]`; + const line = `${prefix}: ${message}`; + if (level === 'ERR') { + console.error(line); + } else { + console.log(line); + } +} + +module.exports = { + /** + * 輸出 INF（一般資訊）等級訊息至 stdout。 + * @param {string} message 訊息內容 + * @param {string} [stage] 階段名稱；未提供時省略 [階段] 區塊 + */ + inf: (message, stage) => write('INF', message, stage), + /** + * 輸出 WRN（警告）等級訊息至 stdout，用於可繼續執行的異常狀況。 + * @param {string} message 訊息內容 + * @param {string} [stage] 階段名稱；未提供時省略 [階段] 區塊 + */ + wrn: (message, stage) => write('WRN', message, stage), + /** + * 輸出 ERR（錯誤）等級訊息至 stderr（console.error）。 + * @param {string} message 訊息內容 + * @param {string} [stage] 階段名稱；未提供時省略 [階段] 區塊 + */ + err: (message, stage) => write('ERR', message, stage), + /** + * 輸出 TRC（細部追蹤）等級訊息至 stdout，用於記錄 API 呼叫等細節。 + * @param {string} message 訊息內容 + * @param {string} [stage] 階段名稱；未提供時省略 [階段] 區塊 + */ + trc: (message, stage) => write('TRC', message, stage), + /** + * 輸出 DBG（除錯）等級訊息至 stdout，用於開發除錯資訊。 + * @param {string} message 訊息內容 + * @param {string} [stage] 階段名稱；未提供時省略 [階段] 區塊 + */ + dbg: (message, stage) => write('DBG', message, stage), +};