Skip to main content

Godot Release Dashboard Kit

godot-release-dashboard-kit builds a small static dashboard from JSON, Markdown, and image artifacts produced by Godot Production Toolkit commands.

It is intentionally simple: point it at a reports folder and it writes a self-contained HTML file suitable for a CI artifact or release checklist. Report cards are grouped into release readiness states so a project can quickly spot blocked checks, warnings that need attention, and ready checks before a release build goes out.

Install

python -m pip install godot-release-dashboard-kit

From a source checkout:

python -m pip install -e .\godot-release-dashboard-kit

Quick Start

godot-release-dashboard build reports\godot-project-doctor --output reports\dashboard.html

Write a machine-readable dashboard summary:

godot-release-dashboard build reports\godot-project-doctor --format json --output reports\dashboard.json

Include scenario run evidence in the same dashboard:

godot-scenario-report bundle reports\scenarios --manifest scenario-manifest.json --telemetry reports\runtime-timeline.json --evidence log=reports\run.log --evidence junit=reports\junit.xml --format json --output reports\release-evidence\scenario-bundle.json
godot-release-dashboard build reports\release-evidence --output reports\dashboard.html

Inputs

The dashboard scans a folder recursively for .json, .md, .png, .jpg, .jpeg, .svg, and .webp files. Toolkit JSON reports are summarized through their tool, kind, and summary fields when available. Image artifacts such as mobile UI overlays, screenshot diffs, pixel previews, and visual smoke captures are embedded into the self-contained HTML output.

Scenario bundle JSON from godot-scenario-report-kit is shown as a release evidence card with scenario pass/fail counts plus the nearby files a reviewer should open next, such as logs, JUnit XML, runtime telemetry, profiler captures, visual-smoke reports, or screenshots. The dashboard shows link metadata from the bundle; it does not run the game or rewrite those evidence files. If the bundle contains a compact telemetry summary, the dashboard also shows sample count, frame p95, frame max, memory max, and budget spike counts.

Outputs

  • html: self-contained static dashboard with release readiness metrics, source report links, report cards, scenario evidence sections, and image previews.
  • json: summary for scripts or later dashboard tooling, including counts for blocked, attention, ready, scenario bundles, scenarios, and linked scenario evidence. Scenario-linked telemetry summaries are rolled up as sample, spike, warning, and error counts.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

godot_release_dashboard_kit-0.1.4.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

godot_release_dashboard_kit-0.1.4-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file godot_release_dashboard_kit-0.1.4.tar.gz.

File metadata

File hashes

Hashes for godot_release_dashboard_kit-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8e7f06b066845dbe808f8bc1fe11cc2209faf74392e3b594a53b9588d76d3a11
MD5 b13cb03b35977d6427209ad24e767704
BLAKE2b-256 eede5db6ef98bc387fddf4a0c3652ae0fbdc2f190864cebe90a4e9e48ba505bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_release_dashboard_kit-0.1.4.tar.gz:

Publisher: publish-release-dashboard-kit.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file godot_release_dashboard_kit-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_release_dashboard_kit-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8ec149b8046bdc13d730028a8cc6d9cd2f8e580bf10d4c6bac51691b17f5e99f
MD5 5a252d919fb22378f3c19278fb127cb0
BLAKE2b-256 1b0e0015f20421787e65cd217f86f39c968c09bb1ba321585e1abee09879319c

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_release_dashboard_kit-0.1.4-py3-none-any.whl:

Publisher: publish-release-dashboard-kit.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page