Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 3.07 KB

File metadata and controls

63 lines (46 loc) · 3.07 KB

Customization Guide

Use this when turning the template into a real app repo.

First Pass

  1. Rename template-aio.xml to your final repo slug, for example myapp-aio.xml.
  2. Replace the placeholder upstream image in Dockerfile.
  3. Replace assets/app-icon.png.
  4. Update README.md, SECURITY.md, and .github/FUNDING.yml.
  5. Replace the starter service command in rootfs/etc/services.d/app/run.
  6. Replace the starter pytest integration assertions in tests/integration/test_container_runtime.py with the real app lifecycle expectations.
  7. Configure the repo in aio-fleet/fleet.yml, export .aio-fleet.yml, and pin the upstream version in the Dockerfile.
  8. Keep the XML <Changes> block in the date-first fleet format generated by aio-fleet release preparation.

Files You Will Almost Always Touch

Internal PostgreSQL

The template includes an optional PostgreSQL example because some AIO repos genuinely need an embedded database.

If the derived app does not need internal PostgreSQL, remove:

If the derived app does need internal PostgreSQL:

  • install the required PostgreSQL packages in Dockerfile
  • replace the example init script with real cluster/bootstrap logic
  • update the integration tests to validate persistence or first-boot expectations when relevant

CI and Publishing

The central aio-fleet control plane publishes from main once the required registry and GitHub App secrets are configured.

Before enabling it:

  • run python3 -m venv .venv && . .venv/bin/activate && pip install -e "../aio-fleet[app-tests]"
  • from aio-fleet, run python -m aio_fleet validate-repo --repo <repo> --repo-path ../<repo>
  • run pytest tests/integration -m integration
  • set all required repository variables and secrets
  • confirm the XML, icon, and package names match the intended public repo
  • confirm the upstream monitor matches the real upstream source and stable channel
  • confirm CHANGELOG.md and the XML <Changes> block describe the same latest release

Trust Signals To Add Before Public Launch

  • one screenshot or meaningful demo visual if the app has a UI
  • a real first-run section in the README
  • an honest limitations or caveats section if the app has rough edges
  • a clear Support and Project URL in the XML