Skip to main content

🚀 ReleasePilot — Deterministic orchestration of white-label app builds

CI Python License Last Commit Open Issues

PyPI Version PyPI Downloads PyPI

ReleasePilot is an assisted release orchestrator that executes yarn commands in an organized, deterministic, and controlled manner, based on variables provided by the operator (platform, contractor, environment, and command).

Its primary goal is to standardize and automate the build, packaging, and delivery process of white-label applications, while respecting the specific differences between contractors, environments, and platforms — without sacrificing human control at critical steps.

ReleasePilot is intentionally designed to orchestrate commands, not to encapsulate low-level logic or highly specific operational flows. For this reason, granular commands, deep customizations, or platform-specific behaviors must live in dedicated build flows, which are then invoked by yarn.

The orchestrator’s responsibility is to order, coordinate, and operate these commands in a consistent, predictable, and auditable way. To enable this, the package.json must define script aliases that follow the ReleasePilot convention:

{platform}:{contractor}:{environment}:{command}

This allows yarn to act as the execution layer, while ReleasePilot acts as the orchestration layer.


🎯 Purpose

ReleasePilot was created to solve a recurring problem in white-label ecosystems:

How can we execute multiple build commands in a consistent, predictable, and auditable way when each application varies by contractor, environment, and platform?

The answer is not blind automation — it is conscious orchestration.


✨ Key Features

  • 🎛️ Orchestration of yarn commands based on operational variables

  • 📱 Multi-platform support (android, ios)

  • 🏢 Automatic discovery of contractors via directory structure

  • 🧪 Automatic discovery of environments per contractor

  • ⚙️ Supported commands: add, build, deploy

  • 🔁 “All” option available in every selection step

  • ⏸️ Assisted execution with human checkpoints between:

    • Environments
    • Contractors
  • 📌 Execution planning identical to the real execution order

  • 📦 Final, traceable release summary

  • 🧩 Simple, pythonic code with no external dependencies


🧠 Operational Philosophy

ReleasePilot does not execute commands randomly.

It:

  • Organizes
  • Orders
  • Operates

Each yarn command is executed within a well-defined context, ensuring that:

  • Builds are not mixed across contractors
  • Environments are strictly respected
  • Artifacts can be safely retrieved between steps
  • The operator has full visibility into what is being executed

📂 Expected Project Structure

project-root/
├─ contractor/
│  ├─ quickup/
│  │  ├─ sandbox/
│  │  ├─ alfa/
│  │  └─ beta/
│  ├─ kompa/
│     ├─ sandbox/
│     ├─ beta/
│     └─ prod/

The project name is automatically inferred from the root directory name.


🧾 Command Pattern

ReleasePilot executes commands following this convention:

yarn {platform}:{contractor}:{environment}:{command}

Example

yarn android:quickup:beta:build

🚀 Installation

Requirements

  • Python 3.9+
  • Node.js + Yarn
  • Git (optional, but recommended for traceability)

🍎 macOS Installation (recommended)

On macOS, the recommended and reliable way to install ReleasePilot as a global CLI is using pipx. This avoids permission issues, conflicts with the system Python, and ensures proper isolation.

1️⃣ Install pipx

python3 -m pip install --user pipx
python3 -m pipx ensurepath

⚠️ After this step, close and reopen your terminal.


2️⃣ Navigate to the project directory

cd release-pilot   # directory containing pyproject.toml

3️⃣ Install ReleasePilot globally

pipx install .

The command will now be available globally as:

release-pilot

▶️ Quick Test

release-pilot

If the interactive menu appears, the installation was successful ✅


🔍 Optional Checks

which release-pilot
pipx list

Expected output (example):

~/.local/bin/release-pilot

🧹 Updating ReleasePilot

After updating the code or version:

pipx reinstall release-pilot

❌ Uninstalling

pipx uninstall release-pilot

⚠️ Important Notes for macOS

  • Do not use sudo pip install
  • Do not use the system Python to install CLIs
  • Do not manually copy binaries
  • For Python CLI tools, pipx is always the correct choice

🧠 Rule of Thumb

Python library → pip install Python CLI tool → pipx install


📌 Execution Planning

Before executing any command, ReleasePilot displays the complete execution plan, in the exact order in which commands will run.

This eliminates ambiguity and ensures full predictability.


✅ Final Release Summary

At the end of execution, ReleasePilot presents a consolidated summary including:

  • 📁 Project
  • 📦 Contractors
  • 🌿 Git branch / version
  • 🧪 Environments
  • 📱 Platforms
  • ⚙️ Total executed commands

This summary improves auditability, communication, and release traceability.


🛡️ Ideal Use Cases

  • White-label app builds
  • Sandbox / alfa / beta / production environments
  • Teams supporting multiple clients
  • Sensitive or regulated releases
  • Teams that require control + automation

🔮 Future Enhancements

  • --dry-run mode
  • Non-interactive execution (--ci)
  • Summary export (.txt / .md)
  • Commit hash and SemVer tag support
  • Slack / Jira / Discord / Telegram integrations
  • Persistent execution logs

📜 License

MIT License.


👤 Author

André Argôlo CTO • Software Architect • DevOps


🧭 About

André Argôlo is a software architect and technology leader with extensive experience in designing and operating mission-critical systems. His work focuses on building scalable platforms, improving developer experience, and creating pragmatic tooling that balances automation with human control — especially in regulated and high-responsibility environments.

Release files for release-pilot 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for release-pilot 1.0.6
File Size Uploaded
release_pilot-1.0.6.tar.gz 7.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for release-pilot 1.0.6
File Interpreter ABI Platform
release_pilot-1.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 15.5 kB

Release files / release_pilot-1.0.6.tar.gz

Download URL release_pilot-1.0.6.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
43e7b542672afd7d25ddae3c9fe1c9b4f4607518657d8bee5987c55c2cb10afe
BLAKE2b-256 checksum
How to use checksums
016a9f06efc51b0e20f68db78fa16cb2ef77ce12baf5c450054dc98726ed85e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 9, 2026.

Transparency log

Release files / release_pilot-1.0.6-py3-none-any.whl

Download URL release_pilot-1.0.6-py3-none-any.whl
Size 8.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7c0e4d54d98e8ede742a4d21b0934a2a1ef8a264bdecb3b6aa9b9a53732f75a0
BLAKE2b-256 checksum
How to use checksums
ae587228a0b09a373da8ae9c6c7505bed9be5cbd2849f3884d84b15e09e3f415
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 9, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.6 This release

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page