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 . --platform Android --required-android-abi arm64-v8a
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

Require a specific Android ABI without creating a config file:

godot-export-doctor . --platform Android --required-android-abi arm64-v8a --fail-on warning

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"]
allowed_secret_patterns = ["<.+>"]

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.5.tar.gz (13.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_export_preset_doctor-0.1.5-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.5.tar.gz
Algorithm Hash digest
SHA256 8bac7f1eab7027f0c4c6444847eff25ba5222216267d758e91dbdc0d3d40a94e
MD5 51713a2626a2df17ce38a3002f09a16e
BLAKE2b-256 2195346637a8c95664c4169d993b85d26daf839a7ebd5071d49a8a0dd8d676a4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cf053356d9c58243d26a961c9f0b58e0319b4572cde4d7899575f69bb1447f13
MD5 eaacf7fa9964fa2ceb989bace5466820
BLAKE2b-256 d3531b35bf2862441d2c2f81ec63f8678dfcefa8d080121688c9df7701f1f4e1

See more details on using hashes here.

Provenance

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