Weekly data workflow only refreshes an unused file and pushes straight to unprotected main

未關閉
#35 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
30/100
Issue 類型
功能
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
csharp, github-actions, unity

研究方向

Start by reading .github/workflows/update-unity-api.yml, .github/scripts/refresh_unity_data.py, and the MCP server references to the JSON data files. Check how the workflow validates and publishes refreshed data, and which files the tools load. Done means data changes arrive in CI-passing PRs, refreshed data is used, and main has the stated protection and lifecycle compatibility behavior; this spans workflow, server, and repository settings.

由索引模型根據 Issue 內容生成。

描述

ci priority: medium security

Why it matters

The weekly "Update Unity API Data" workflow looks like it keeps the API database current, but it only rewrites lifecycle_order.json, which no MCP tool reads. It also pushes directly to an unprotected main, pinned to an old docs version. It gives a false sense of freshness while adding unreviewed commits.

Evidence

  • .github/scripts/refresh_unity_data.py:118-121 - only lifecycle_order.json is refreshed. unity_api_common.json, deprecated_patterns.json, shader_properties.json, platform_defines.json are never updated.
  • grep lifecycle_order mcp-server/server.py returns nothing: no tool loads that file.
  • refresh_unity_data.py:22 - UNITY_DOCS_BASE = ".../6000.1/Documentation/ScriptReference" is hardcoded.
  • The lifecycle list includes OnPreCull, OnPreRender, OnPostRender, OnRenderImage, which are not called in URP/HDRP, with no pipeline note.
  • .github/workflows/update-unity-api.yml commits and git pushes straight to main; gh api .../branches/main/protection returns "Branch not protected".

Suggested approach

  • Either expose lifecycle data through a tool (e.g. a lifecycle_info tool or include it in lookup_api) or stop refreshing it.
  • Rename the workflow to reflect what it does, read the docs version from a single config value, and open a PR (e.g. peter-evans/create-pull-request) instead of pushing to main.
  • Enable branch protection on main with required status checks (Validate), and allow the release bot through a ruleset bypass.
  • Add a pipeline-compatibility field to lifecycle entries.

Done when

Automated data changes arrive as PRs that pass CI, the refreshed data is actually used, and main is protected.

主要語言
C#
星號
4
分支
0
PR 合併指標
30 天內沒有已合併 PR

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

TMHSDigital/Unity-Developer-Tools 的其他 Issue

查看 TMHSDigital/Unity-Developer-Tools 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。