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.3.tar.gz (13.2 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.3-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1428def35c34939c4d243a80069d28b13a603eac41001b76140b6e4351bdc32a
MD5 57f304e46d3807c71aa603c070546ed5
BLAKE2b-256 d1c2836dab264bcbbcb783270ce03eee110e010ec1e259e8bf38d215f62067ac

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for godot_export_preset_doctor-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f711dc7119b5ad14fe826ba0b4e4cdc43dccbe4283d96c98f6f396ace1bc5db5
MD5 38ad876e1ca5d037d82ae48ebf871927
BLAKE2b-256 0c4a49dc38909fa60643e707d35aafda881046a2c513007e12a32493d4d3bb3b

See more details on using hashes here.

Provenance

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