Routine dependency hygiene: Dependabot coverage, action majors, pins, templates

Offen
#62 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
65/100
Issue-Typ
Refactoring
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, javascript, lua, markdown, python, typescript, yaml

Rechercherichtung

Start by reading .github/dependabot.yml and then each workflow named in the issue (deploy-docs.yml around lines 24-43, validate.yml:240, update-natives.yml, update-docs-index.yml, stale.yml) to see which action versions are in use. For the docs pinning, add a docs/requirements.txt with mkdocs-material==9.8.* and point the install step at it; for templates, edit templates/nui-vite/web/package.json, templates/nui-svelte/web/package.json, templates/javascript/package.json and the six fxmanifest.lua files. Done means Dependabot lists pip/npm entries, npm run build passes in both NUI templates, and no manifest references an undeclared resource. CI checks live in .github/workflows/validate.yml; there is no local test suite.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

dependencies severity: low

Summary

Routine dependency hygiene items: Dependabot covers only GitHub Actions, two action majors are behind, the docs build installs an unpinned mkdocs-material, the NUI templates start new projects on older majors, the JS template uses "latest" typings, and six framework templates include oxmysql without declaring it.

Where

  • .github/dependabot.yml:1-6
  • .github/workflows/deploy-docs.yml:24, 29, 43, .github/workflows/validate.yml:240, .github/workflows/update-natives.yml:18, .github/workflows/update-docs-index.yml:18, .github/workflows/stale.yml:17
  • templates/nui-vite/web/package.json:17-19, templates/nui-svelte/web/package.json:15-16
  • templates/javascript/package.json:7-8
  • templates/{esx,qbcore,qbox,oxcore,rsg,vorp}/fxmanifest.lua:19

Details

  • Dependabot coverage. Only package-ecosystem: "github-actions" is configured. There is no pip entry for /mcp-server and no npm entries for templates/nui-vite/web, templates/nui-svelte/web or templates/javascript. The nui-svelte peer conflict tracked in "nui-svelte fails npm install: vite-plugin-svelte 4 needs vite 5, pins vite 6" would likely have been surfaced.
  • Action majors. actions/setup-python@v6 (4 workflows) has a v7 major available; actions/stale@v10 has v11. If Dependabot PRs for these exist, check why they were not merged.
  • mkdocs-material unpinned. deploy-docs.yml:29 runs pip install mkdocs-material with no version and builds with mkdocs build --strict, so any upstream release can break the deploy with no repo change. Its base package mkdocs has had no release since 2024-08.
  • NUI templates behind. Both templates use vite ^6.0.0, typescript ^5.7.0, and nui-vite @vitejs/plugin-react ^4.4.0, two majors behind current releases. This is staleness, not a known vulnerability.
  • "latest" typings. @citizenfx/client and @citizenfx/server are "latest", so different users get different typings.
  • Undeclared oxmysql. Six framework manifests list '@oxmysql/lib/MySQL.lua' in server_scripts but declare only the framework dependency, and no template server file uses MySQL. On a server without oxmysql the resource fails to load, and start order is not guaranteed.

Impact

No automated alerts for Python or template dependency issues, a docs deploy that can break on any upstream release, and new resources that start on outdated tooling or carry an unused hard database dependency.

Suggested fix

  • Add pip (/mcp-server, weekly) and optionally npm entries for each template web/ directory with versioning-strategy: increase.
  • Bump actions/setup-python to v7 and actions/stale to v11 (or SHA-pin them per "Pin workflow actions to commit SHAs and narrow release write scope").
  • Pin docs dependencies (for example mkdocs-material==9.8.* in docs/requirements.txt) and let Dependabot track them.
  • Migrate both NUI templates to current vite with matching plugin majors in one change, verifying npm run build.
  • Replace "latest" with a caret range on the current @citizenfx/* version.
  • Either remove the oxmysql include from the six templates or add oxmysql to their dependencies with a comment that it is only needed for DB access.

Acceptance criteria

  • Dependabot covers pip (and optionally npm) manifests.
  • Workflows use current action majors.
  • The docs build installs pinned versions.
  • Template package versions are explicit ranges and both NUI templates build.
  • No template includes a resource file it does not declare as a dependency.

Getting started

  • Relevant files: .github/dependabot.yml, .github/workflows/*.yml, templates/*/package.json, templates/*/web/package.json, templates/*/fxmanifest.lua
  • How to run checks: there is no test suite yet; run the MCP server with cd mcp-server && pip install -r requirements.txt && python server.py, and CI checks live in .github/workflows/validate.yml
  • Related docs: GitHub Dependabot configuration reference

Filed by repo-audit/full-audit at 701824d. Severity: low. Effort: S. audit-key: dependencies|.github/dependabot.yml|routine

Vorherrschende Sprache
Python
Sterne
7
Forks
4
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/CFX-Developer-Tools

Alle Issues in TMHSDigital/CFX-Developer-Tools

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.