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

Aperta
#35 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
csharp, github-actions, unity

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
C#
Stelle
4
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Unity-Developer-Tools

Tutte le issue di TMHSDigital/Unity-Developer-Tools

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.