Skip to content

Commit eb302bd

Browse files
committed
docs: document deferred profile issue closure
1 parent 91be918 commit eb302bd

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

‎docs/maintainer-guide.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ LLM agents 不應讀取 service account credentials,也不應在沒有明確
6262
| `Apply profile claims` | `credits-profiles` PR 或 issue comment checkbox dispatch、手動觸發 | 維護者確認標記網址後,重新驗證 confirmation comment 與 canonical Sheet,將仍符合的 `site:` appearances 改成該 GitHub username;PR mode 會重跑 profile PR review,issue mode 會觸發 Pages rebuild。 |
6363
| `Deploy GitHub Pages` | `master` push、profile rebuild dispatch、手動觸發 | 匯出 canonical Google Sheet、checkout `credits-profiles`、驗證資料與 site profile references、建立 `dist/`,部署到 GitHub Pages;profile PR 或 claim-only issue 觸發的部署成功後,回到對應 PR 或 issue 留言告知公開頁面連結,並關閉 linked issue 或原 issue。 |
6464

65+
profile issue form 產生的 PR 會用 `Refs #...` 連回原 issue,而不是使用 GitHub 會在 PR merge 時自動關 issue 的 close keyword。profile PR merge 只是 `credits-profiles` 的 profile JSON 已合併,還要等 `credits` 重新匯出 canonical Sheet、重建並部署 Pages 後,公開頁面才可確認。issue 的完成狀態因此由 `Deploy GitHub Pages` 的部署後 comment/close 控制;若連續 profile merge 讓較早的 Pages run 被 concurrency 取消,後續成功部署會掃描近期已 merge 的 profile PR,補齊被取消 run 遺失的 issue 收尾。
66+
6567
`CI` 不讀取 service account credentials、不連線 Google APIs,也不匯出 canonical Sheet。`Export Sheets data`、`Sync people helper`、`Review profile PR` 和 `Deploy GitHub Pages` 需要維護者先在 GitHub repository secrets 設定 `GOOGLE_SERVICE_ACCOUNT_JSON`。
6668

6769
跨 repo 寫入、留言、核准或合併 `credits-profiles` 另需安裝 `SITCON Credits Assistant` GitHub App,並設定:

‎docs/workflows.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ flowchart TD
110110

111111
若 deploy 是由 `credits-profiles` profile PR merge 後的 rebuild dispatch 觸發,而且 dispatch payload 可辨識單一 `profiles/<github_username>.json` PR,部署成功後 workflow 會回到該 PR 留言;若 PR body linked 到 profile request issue,也會先回到原 issue 留言,提供 `https://sitcon.org/credits/#person=<github_username>` 讓貢獻者查看公開呈現,再關閉原 issue。claim-only issue 套用成功後也會走同一個 Pages deploy 成功通知,但 payload 只帶原 issue number,不需要建立 profile PR。
112112

113+
profile issue form 產生的 PR body 刻意使用 `Refs #...`,而不是 `Closes #...`、`Fixes #...` 或 `Resolves #...`。這是因為 profile PR merge 只代表 profile JSON 已進入 `credits-profiles`,還不代表 `credits` 已重新匯出 canonical Sheet、重建並部署公開 Pages。若使用 GitHub 自動 close keyword,issue 會在 PR merge 時提早關閉,維護者和貢獻者無法從 issue 狀態判斷後續 rebuild 是否真的完成。正確完成點是 Pages deploy 成功後,由 `Deploy GitHub Pages` 留下公開頁面連結,再由 bot 明確關閉 linked issue。
114+
115+
`Deploy GitHub Pages` 使用 workflow concurrency 讓連續 profile merge 的 Pages rebuild 收斂到最新一次。較早的 rebuild run 可能被後續 run 取消;這是為了避免短時間重複部署。為了不讓被取消 run 的 profile request issue 遺失收尾,部署成功後的通知步驟除了處理當次 dispatch payload,也會掃描近期已 merge、linked 到 profile request issue、且修改單一 `profiles/*.json` 的 profile PR,補上同一則已部署 comment 並關閉 linked issue。
116+
113117
Pages 網頁預設只提供公開索引查詢。貢獻者需要請維護者確認哪些項目可能是在記錄自己時,可以打開 [標記我的貢獻紀錄](https://sitcon.org/credits/?claim=1);頁面會把選取結果保存在網址中,讓貢獻者直接分享該頁網址。這個 handoff 不會寫入 Google Sheets,也不會讓 profile PR 自動完成身份合併;維護者仍需在 canonical Sheet 中人工確認後,才可調整 `appearances.github_username`。
114118

115119
Pages 前端是公開索引與標記流程的原型凍結版,會繼續透過 GitHub Actions 部署公開輸出。部署失敗、資料安全或隱私風險、公開資料明顯錯誤、既有必要流程無法使用時,仍可依問題性質另外處理;其他前端新功能、介面微調、體驗修補或重新設計期待,請集中到 [Pages 前端重新設計需求盤點](https://github.com/sitcon-tw/credits/issues/2),作為後續訪談、設計討論與規劃輸入。

0 commit comments

Comments
 (0)