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

オープン
#35 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TMHSDigital/Unity-Developer-Tools のほかの issue

TMHSDigital/Unity-Developer-Tools の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。