Weekly data workflow only refreshes an unused file and pushes straight to unprotected main
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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- onlylifecycle_order.jsonis refreshed.unity_api_common.json,deprecated_patterns.json,shader_properties.json,platform_defines.jsonare never updated.grep lifecycle_order mcp-server/server.pyreturns 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.ymlcommits andgit pushes straight tomain;gh api .../branches/main/protectionreturns "Branch not protected".
Suggested approach
- Either expose lifecycle data through a tool (e.g. a
lifecycle_infotool or include it inlookup_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 tomain. - Enable branch protection on
mainwith 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.
- Linguagem predominante
- C#
- Estrelas
- 4
- Forks
- 0
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de TMHSDigital/Unity-Developer-Tools
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
-
ci priority: low skills
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
-
good first issue skills testing
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
-
ci priority: medium testing
Dificuldade 4/5 1-2 dias Facilidade para iniciantes 57/100
-
documentation marketing priority: medium
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
Todas as issues de TMHSDigital/Unity-Developer-Tools
Issues semelhantes
-
type:task ux
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
elsa-workflows/elsa-foundation#5253 ·
Mantenedores costumam responder em até 1 dia