old-composite-actions/release-tag-version
2
0
Fork 0
Code Pull Requests Actions Releases 2 Activity

docs: 補齊指令檔逐行註解並重建 README #13

Merged
admin merged 2 commits from ai-review-resolve/develop-20260626-104947 into develop 2026-06-26 02:54:48 +00:00
Conversation 2 Commits 2 Files Changed 5
+254 -6
jiantw83 commented 2026-06-26 02:52:50 +00:00
Member
Copy Link
Copy Source

變更摘要

為本 composite action 專案補齊文件，並重建 README。屬純文件／註解變更，未更動任何 runtime 邏輯。

  • action.yml：新增檔頭「用途 + 更新日期」區塊，並對每個 step、input、bash 指令補上逐行繁體中文註解（含五步驟流程說明）。
  • .gitea/workflows/ci.yaml：補檔頭區塊與逐行註解，說明 PR 觸發、AI 程式碼審查 job、權限與 token 來源。
  • .gitea/workflows/cd.yaml：補檔頭區塊與逐行註解，說明 push master 觸發、checkout 與引用根目錄 composite action。
  • README.md：刪除舊版後重建，含專案列表（專案描述／參考專案／NuGet 三張表）、功能列表與使用範例。

影響範圍

  • 僅文件與註解，YAML 指令本體（key／值／step 順序）與原檔完全一致，已通過 YAML 語法驗證。
  • 三個 workflow／action 檔的執行行為不變。

重點檔案

檔案 變更性質
action.yml 逐行註解 + 檔頭用途/日期
.gitea/workflows/ci.yaml 逐行註解 + 檔頭用途/日期
.gitea/workflows/cd.yaml 逐行註解 + 檔頭用途/日期
README.md 重建

風險或注意事項

  • action.yml 的 run: | 區塊內新增的是 bash 註解（#，no-op），不影響腳本行為。
  • 數處以 # 需人工確認 標註待評估項目（runner label、各 vars.ACTION_* 變數與 secrets.COMMENT_TOKEN 是否已設定、contents: write 權限是否必要），僅為提醒，未改動邏輯。
## 變更摘要 為本 composite action 專案補齊文件，並重建 README。屬純文件／註解變更，**未更動任何 runtime 邏輯**。 - `action.yml`：新增檔頭「用途 + 更新日期」區塊，並對每個 step、input、bash 指令補上逐行繁體中文註解（含五步驟流程說明）。 - `.gitea/workflows/ci.yaml`：補檔頭區塊與逐行註解，說明 PR 觸發、AI 程式碼審查 job、權限與 token 來源。 - `.gitea/workflows/cd.yaml`：補檔頭區塊與逐行註解，說明 push master 觸發、checkout 與引用根目錄 composite action。 - `README.md`：刪除舊版後重建，含專案列表（專案描述／參考專案／NuGet 三張表）、功能列表與使用範例。 ## 影響範圍 - 僅文件與註解，YAML 指令本體（key／值／step 順序）與原檔完全一致，已通過 YAML 語法驗證。 - 三個 workflow／action 檔的執行行為不變。 ## 重點檔案 | 檔案 | 變更性質 | | --- | --- | | `action.yml` | 逐行註解 + 檔頭用途/日期 | | `.gitea/workflows/ci.yaml` | 逐行註解 + 檔頭用途/日期 | | `.gitea/workflows/cd.yaml` | 逐行註解 + 檔頭用途/日期 | | `README.md` | 重建 | ## 風險或注意事項 - `action.yml` 的 `run: |` 區塊內新增的是 bash 註解（`#`，no-op），不影響腳本行為。 - 數處以 `# 需人工確認` 標註待評估項目（runner label、各 `vars.ACTION_*` 變數與 `secrets.COMMENT_TOKEN` 是否已設定、`contents: write` 權限是否必要），僅為提醒，未改動邏輯。
jiantw83 added 1 commit 2026-06-26 02:52:50 +00:00
docs(指令檔與 README): 補齊 action.yml 與 CI/CD workflow 逐行註解並重建 README
CI / AI Code Review (pull_request) Successful in 35s
Details
fcc75cf75c
admin commented 2026-06-26 02:52:54 +00:00
Owner
Copy Link
Copy Source

🤖 AI Code Review 團隊

👤 角色 🎯 面向 🧠 個性
🗡️ Assassin security 多疑偏執、以攻擊者視角看世界，假設每筆輸入都是惡意的，每個信任都會被濫用
🎼 Bard style 唯美龜毛、追求優雅，把可讀性與一致性當作旋律，最受不了走調的命名與排版
🧰 Leo maintainability 有遠見、重視長期維護成本，凡事先問「六個月後的自己還看得懂嗎？」，討厭把債留給未來
🔮 Mage logic 嚴謹冷靜、滴水不漏，凡事推演到最壞情況，深信「沒驗證過的假設都是 bug」
🧪 Maya testing 對測試覆蓋率有執念，深信「沒有測試的程式碼等於沒寫完」，溫和但堅持，最在意邊界與失敗路徑
⚡ Rogue efficiency 急性子、講求速度，最痛恨被浪費的 CPU 週期與記憶體，凡事先問「這能不能更快、更省」

🔍 服務：opencode 模型：gemini-2.5-flash

## 🤖 AI Code Review 團隊 | 👤 角色 | 🎯 面向 | 🧠 個性 | |--------|--------|--------| | **🗡️ Assassin** | security | 多疑偏執、以攻擊者視角看世界，假設每筆輸入都是惡意的，每個信任都會被濫用 | | **🎼 Bard** | style | 唯美龜毛、追求優雅，把可讀性與一致性當作旋律，最受不了走調的命名與排版 | | **🧰 Leo** | maintainability | 有遠見、重視長期維護成本，凡事先問「六個月後的自己還看得懂嗎？」，討厭把債留給未來 | | **🔮 Mage** | logic | 嚴謹冷靜、滴水不漏，凡事推演到最壞情況，深信「沒驗證過的假設都是 bug」 | | **🧪 Maya** | testing | 對測試覆蓋率有執念，深信「沒有測試的程式碼等於沒寫完」，溫和但堅持，最在意邊界與失敗路徑 | | **⚡ Rogue** | efficiency | 急性子、講求速度，最痛恨被浪費的 CPU 週期與記憶體，凡事先問「這能不能更快、更省」 | > 🔍 服務：opencode 模型：gemini-2.5-flash
admin reviewed 2026-06-26 02:53:25 +00:00
admin left a comment
Owner
Copy Link
Copy Source

AI Code Review 統計

類型 🔴 嚴重 🟡 警告 🔵 建議 ⚪ 無法標示
新問題 0 筆 4 筆 1 筆 0 筆
舊問題 0 筆 0 筆 0 筆 0 筆

🤖 AI 助理使用量

本次審查（opencode / gemini-2.5-flash，共 12 次呼叫）

提示 token 回應 token 合計
49,126 1,521 161,793

剩餘可用

剩餘可用：無法計算百分比（自架服務，無帳號額度概念）

## AI Code Review 統計 | 類型 | 🔴 嚴重 | 🟡 警告 | 🔵 建議 | ⚪ 無法標示 | | --- | --- | --- | --- | --- | | 新問題 | 0 筆 | 4 筆 | 1 筆 | 0 筆 | | 舊問題 | 0 筆 | 0 筆 | 0 筆 | 0 筆 | ## 🤖 AI 助理使用量 **本次審查**（opencode / gemini-2.5-flash，共 12 次呼叫） | 提示 token | 回應 token | 合計 | | --- | --- | --- | | 49,126 | 1,521 | 161,793 | **剩餘可用** 剩餘可用：無法計算百分比（自架服務，無帳號額度概念）
action.yml
@@ -1,37 +1,122 @@
# =============================================================================
admin commented 2026-06-26 02:53:25 +00:00
Owner
Copy Link
Copy Source

嚴重等級：🟡 警告
審查員：Bard
問題：檔案頭部充斥著過度冗長、瑣碎且描述基礎 YAML 語法的註解，破壞了設定檔應有的簡潔層次，且增加了維護負擔。
建議：建議大幅精簡檔案頭部註解，僅保留必要的業務邏輯摘要，移除過細的步驟解說與基礎語法定義。

**嚴重等級**：🟡 警告 **審查員**：Bard **問題**：檔案頭部充斥著過度冗長、瑣碎且描述基礎 YAML 語法的註解，破壞了設定檔應有的簡潔層次，且增加了維護負擔。 **建議**：建議大幅精簡檔案頭部註解，僅保留必要的業務邏輯摘要，移除過細的步驟解說與基礎語法定義。
action.yml
@@ -4,1 +22,4 @@
# inputs 區塊：定義此 composite action 對外開放、可由呼叫方傳入的參數。
inputs:
# files 參數：指定要隨 release 一起釋出（上傳）的檔案。
admin commented 2026-06-26 02:53:25 +00:00
Owner
Copy Link
Copy Source

嚴重等級：🟡 警告
審查員：Leo
問題：參數 files 的 description 為空，使得呼叫方在查閱使用說明時缺乏必要的上下文，未來維護者也難以快速掌握此參數的具體用途。
建議：補上具體說明，例如 description: '要釋出的成品檔案路徑或 glob'。

**嚴重等級**：🟡 警告 **審查員**：Leo **問題**：參數 `files` 的 `description` 為空，使得呼叫方在查閱使用說明時缺乏必要的上下文，未來維護者也難以快速掌握此參數的具體用途。 **建議**：補上具體說明，例如 `description: '要釋出的成品檔案路徑或 glob'`。
action.yml
@@ -11,0 +40,4 @@
# ---------------------------------------------------------------------------
# Step 1：版本號計算
# 引用外部 calculate-version action 來計算本次要釋出的版本號，
# 其結果會以 output「version」提供給後續步驟（透過 step id 取用）。
admin commented 2026-06-26 02:53:25 +00:00
Owner
Copy Link
Copy Source

嚴重等級：🔵 建議
審查員：Bard
問題：檔案中充斥著過度細節的區塊註解（例如 Step 1, Step 2...），對於熟悉 YAML 與 Actions 的開發者而言，這些註解顯得冗餘且干擾了閱讀的流暢節奏。
建議：移除這些描述顯而易見行為的步驟區塊註解，讓程式碼結構一目瞭然，僅在 shell 腳本的複雜邏輯處加入關鍵註解即可。

**嚴重等級**：🔵 建議 **審查員**：Bard **問題**：檔案中充斥著過度細節的區塊註解（例如 Step 1, Step 2...），對於熟悉 YAML 與 Actions 的開發者而言，這些註解顯得冗餘且干擾了閱讀的流暢節奏。 **建議**：移除這些描述顯而易見行為的步驟區塊註解，讓程式碼結構一目瞭然，僅在 shell 腳本的複雜邏輯處加入關鍵註解即可。
action.yml
@@ -11,2 +44,4 @@
# ---------------------------------------------------------------------------
- name: 版本號計算
# id 設為 version-calculate，後續步驟以 steps.version-calculate.outputs.version 取得計算結果。
id: version-calculate
admin commented 2026-06-26 02:53:25 +00:00
Owner
Copy Link
Copy Source

嚴重等級：🟡 警告
審查員：Mage
問題：Step 2 將 version_value 直接寫入 GITHUB_OUTPUT 而未進行格式驗證。若上游 calculate-version 輸出的內容包含換行符或其他特殊字元，可能會導致 GITHUB_OUTPUT 格式損壞，甚至產生環境變數注入風險。
建議：在寫入 GITHUB_OUTPUT 前，應使用 regex 驗證 version_value 是否符合預期的版本號格式（例如僅包含數字與點號）。

**嚴重等級**：🟡 警告 **審查員**：Mage **問題**：Step 2 將 version_value 直接寫入 GITHUB_OUTPUT 而未進行格式驗證。若上游 calculate-version 輸出的內容包含換行符或其他特殊字元，可能會導致 GITHUB_OUTPUT 格式損壞，甚至產生環境變數注入風險。 **建議**：在寫入 GITHUB_OUTPUT 前，應使用 regex 驗證 version_value 是否符合預期的版本號格式（例如僅包含數字與點號）。
action.yml
@@ -31,2 +104,4 @@
# with：傳入 release action 所需的參數。
with:
# name：release 的顯示名稱，來自 Step 2 組出的 outputs.name（格式「<repo 名稱> v<版本>」）。
name: ${{ steps.release-params.outputs.name }}
admin commented 2026-06-26 02:53:25 +00:00
Owner
Copy Link
Copy Source

嚴重等級：🟡 警告
審查員：Mage
問題：Step 4 直接使用 gitea.ref 作為 target_commitish。若此 Action 被 Tag 事件觸發，gitea.ref 可能為 refs/tags/...，這在某些 Gitea release 工具中可能無法正確對應到 Commit，導致發布失敗。
建議：建議將 target_commitish 改為使用 ${{ gitea.sha }}，以確保 Release 錨定在正確的 Commit SHA 上，避免因 Ref 格式問題導致執行失敗。

**嚴重等級**：🟡 警告 **審查員**：Mage **問題**：Step 4 直接使用 gitea.ref 作為 target_commitish。若此 Action 被 Tag 事件觸發，gitea.ref 可能為 refs/tags/...，這在某些 Gitea release 工具中可能無法正確對應到 Commit，導致發布失敗。 **建議**：建議將 target_commitish 改為使用 ${{ gitea.sha }}，以確保 Release 錨定在正確的 Commit SHA 上，避免因 Ref 格式問題導致執行失敗。
gitea-actions bot added 1 commit 2026-06-26 02:53:26 +00:00
chore: update ai-review findings [ai-review-bot][success] 69f314af9e
admin merged commit cf80372ed0 into develop 2026-06-26 02:54:48 +00:00
admin deleted branch ai-review-resolve/develop-20260626-104947 2026-06-26 02:54:48 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
admin
Labels
No items
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
admin (系統管理員) jiantw83 (Jeffery)
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: old-composite-actions/release-tag-version#13