docs(指令檔與 README): 補齊 action 與 workflow 逐行註解並新增專案 README #10

Merged

admin merged 1 commits from develop into master 2026-07-03 03:55:31 +00:00

Conversation 0 Commits 1 Files Changed 4

+213 -1

jiantw83 commented 2026-07-03 03:54:38 +00:00

Member

Copy Link

Copy Source

變更摘要

為本 Gitea composite action repo 補齊文件：於 action.yml 與兩支 workflow 加上開頭用途／更新日期區塊與逐行 # 註解，並新增專案根目錄 README.md。僅新增註解與文件，未變更任何指令邏輯或執行行為。

影響範圍

• action.yml（composite action 定義）
• .gitea/workflows/ci.yaml（CI workflow）
• .gitea/workflows/master.yaml（CD workflow）
• README.md（新增）

重點變更

• 三支 YAML 皆於檔首加入單一註解區塊（用途說明 + 更新日期），並對每行有效指令補上繁體中文 # 註解；YAML 解析驗證通過，行為不變。
• action.yml 僅新增註解與檔尾換行，node 執行行內容 byte 完全一致。
• 新增 README.md：含更新時間、專案列表（專案描述／參考專案／NuGet 三張表，專案名稱連向 Gitea 遠端資料夾）、功能列表（本專案為 composite action，無公開程式方法，如實標註），以及「如何在 workflow 引用此 action」的使用範例與對應 workflow 檔案對照表。

風險與注意事項

• 註解過程順帶標註了兩點既有、需人工確認的問題（本 PR 未修改對應程式行，僅以註解標示）：
  • action.yml 的 outputs.message 參照 steps.exchange.outputs.message，但 steps 中並無 id 為 exchange 的步驟，該 output 可能取不到值。
  • master.yaml 的 COMMIT_SHA: gitea.event.commits[1].id 取事件中第二個 commit（索引 1），單一 commit 的 push 可能取不到值。
• 本 PR 為純文件／註解變更，不影響 CI／CD 執行結果。

## 變更摘要 為本 Gitea composite action repo 補齊文件：於 `action.yml` 與兩支 workflow 加上開頭用途／更新日期區塊與逐行 `#` 註解，並新增專案根目錄 `README.md`。僅新增註解與文件，未變更任何指令邏輯或執行行為。 ## 影響範圍 - `action.yml`（composite action 定義） - `.gitea/workflows/ci.yaml`（CI workflow） - `.gitea/workflows/master.yaml`（CD workflow） - `README.md`（新增） ## 重點變更 - 三支 YAML 皆於檔首加入單一註解區塊（用途說明 + 更新日期），並對每行有效指令補上繁體中文 `#` 註解；YAML 解析驗證通過，行為不變。 - `action.yml` 僅新增註解與檔尾換行，`node` 執行行內容 byte 完全一致。 - 新增 `README.md`：含更新時間、專案列表（專案描述／參考專案／NuGet 三張表，專案名稱連向 Gitea 遠端資料夾）、功能列表（本專案為 composite action，無公開程式方法，如實標註），以及「如何在 workflow 引用此 action」的使用範例與對應 workflow 檔案對照表。 ## 風險與注意事項 - 註解過程順帶標註了兩點既有、需人工確認的問題（本 PR 未修改對應程式行，僅以註解標示）： - `action.yml` 的 `outputs.message` 參照 `steps.exchange.outputs.message`，但 steps 中並無 id 為 `exchange` 的步驟，該 output 可能取不到值。 - `master.yaml` 的 `COMMIT_SHA: gitea.event.commits[1].id` 取事件中第二個 commit（索引 1），單一 commit 的 push 可能取不到值。 - 本 PR 為純文件／註解變更，不影響 CI／CD 執行結果。

jiantw83 added 1 commit 2026-07-03 03:54:38 +00:00

docs(指令檔與 README): 補齊 action 與 workflow 逐行註解並新增專案 README aa7f4b2008

admin merged commit ffd714ab93 into master 2026-07-03 03:55:31 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

No items

No labels

Milestone

No items

No Milestone

Assignees

Clear assignees

admin (系統管理員) jiantw83 (Jeffery)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: actions/setup-codex#10