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 workflows. It does not build the game; it catches risky preset drift before a release job runs godot --headless --export-release.

Use it when a release preset changes, when setting up a new export target, or before cutting a public build from CI.

Install

python -m pip install -e .

From PyPI:

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

Real Workflow: Gate Release Presets In CI

Run the checker before a Godot export step so preset drift fails early:

godot-export-doctor . --platform Android --fail-on warning --format sarif --output reports\export-doctor.sarif

This is especially useful for:

  • catching debug flags that were left enabled in release-like presets;
  • checking Android package id, version, icon, and ABI readiness;
  • spotting local keystore paths or literal credential values before reports are shared;
  • confirming export paths exist and match the expected target.

For a first pass on an existing project, avoid failing the build while you review findings:

godot-export-doctor . --platform Android --fail-on none --format json --output reports\export-doctor.json

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 scripts and CI.

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

CI Example

- run: python -m pip install godot-export-preset-doctor
- run: godot-export-doctor . --platform Android --fail-on warning --format sarif --output reports/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.2.tar.gz (12.9 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.2-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.2.tar.gz
Algorithm Hash digest
SHA256 47d841c85de7c4b0324f4b752d7170f30de600ddd8c010aa410a02e7032e7741
MD5 d43fc574e2efb74b64213e918f0af6a5
BLAKE2b-256 7907002dbfedd5b371723a27840dba2f88abb6b6fd76dd4e6e99d35beaa8a8af

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_export_preset_doctor-0.1.2.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.2-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 51e727ad90c730323262f365f75e9141d492eb14fe3b8870eaaeadd5b9b86833
MD5 cbcb3280aa5f34c9fa236cadeae450b9
BLAKE2b-256 ea06f0236b1d9743bb62176b3297c51729b185935532b684109acf4e24754897

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_export_preset_doctor-0.1.2-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