Skip to main content

CI-friendly release-readiness checks for Godot export_presets.cfg files.

Project description

Godot Export Preset Doctor

Release-readiness checks for Godot export_presets.cfg, focused on Android, CI export hygiene, debug flags, signing safety, package identity, ABIs, icons, and missing export paths.

The tool is a companion to export automation. It does not build the game; it catches risky preset drift before a release job runs godot --headless --export-release.

Install

python -m pip install -e .

When published:

python -m pip install godot-export-preset-doctor

Quick Start

godot-export-doctor C:\Projects\MyGame
godot-export-doctor . --platform Android
godot-export-doctor . --format sarif --output export-doctor.sarif

Use --fail-on none while exploring a report:

godot-export-doctor examples\bad-export-project --fail-on none

What It Checks

  • Missing export_presets.cfg.
  • Missing preset name, platform, or export path.
  • Android package id, version code/name, enabled ABI, and launcher icon readiness.
  • Release-like presets with debug options enabled.
  • Hard-coded password, token, secret, or keystore-like values.
  • JSON and SARIF output for automation.

Configuration

Create .godot-export-doctor.toml:

format = "text"
fail_on = "warning"
platform = "Android"
required_android_abis = ["arm64-v8a"]

CLI flags override config values.

Output

Text:

godot-export-doctor .

JSON:

godot-export-doctor . --format json --output export-report.json

SARIF:

godot-export-doctor . --format sarif --output export-doctor.sarif

Documentation

Development

python -m pip install -e .
python -m unittest discover -s tests -v
godot-export-doctor examples\bad-export-project --fail-on none

Design Notes

The checker is intentionally static. It reads Godot config files and reports conservative findings that are useful in local development and CI. It does not need the Godot editor, Android SDK, or network access.

Examples and fixtures are generic by design. They should be safe to publish without exposing private project details.

Project details


Download files

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

Source Distribution

godot_export_preset_doctor-0.1.0.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

godot_export_preset_doctor-0.1.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file godot_export_preset_doctor-0.1.0.tar.gz.

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 496ccc00cea20ff2153f0581e9f515a99acd5ffd63fbdff31d8ebbd07ef0793a
MD5 dd563b4d391349ce795bfb210bed902e
BLAKE2b-256 2b7ca25a6b43c11dfd937c70af6f17e009c3dafb8e5b37a8f6038fd3391c83d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_export_preset_doctor-0.1.0.tar.gz:

Publisher: publish-export-preset-doctor.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_export_preset_doctor-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0854b4060abd684db00ab673f9ad7a887f73292fd4748ad85f3e4fdce09897e2
MD5 2babef04b3cf0094ef3f3df6fdcdfa53
BLAKE2b-256 2d5e8fdc6616546dfc7dddd6b44547d3a68b61e2730fb06721a36e277216c4a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_export_preset_doctor-0.1.0-py3-none-any.whl:

Publisher: publish-export-preset-doctor.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