Handbook

Fleet Apps publishing

Use this checklist before publishing a FAEP package to fleet.forgesdlc.com.

Updated

Prerequisites

  • Package built with scripts/build-fleet-app.sh in the app repo.
  • fleet-app.page.md frontmatter matches fleet-app-manifest.schema.json.
  • ui/app.ui.json validates against fleet-app-ui-v1.schema.json.
  • Ship RELEASE-NOTES.md at the zip root (markdown for the published version only). The publish script copies it into catalog.json as release_notes and Fleet stores it on install for the admin About fly-out.

Publish (forge-fleet-website)

From forge-fleet-website:

./scripts/publish-fleet-app.sh \
  --package /path/to/app/dist/forge-cdp-manager-0.2.0.fleet-app.zip

App repos may ship a thin wrapper, e.g. forge-cdp-manager/scripts/publish-fleet-app.sh --deploy, which builds then calls this script.

Manifest version is stamped from pyproject.toml at build time; validate-fleet-app-package.py checks wheel semver matches manifest.

With deploy:

./scripts/publish-fleet-app.sh \
  --package /path/to/app/dist/forge-cdp-manager-0.2.0.fleet-app.zip \
  --deploy

The script:

  1. Validates the zip layout and schemas.
  2. Copies the zip to website/packages/.
  3. Updates forge-fleet/docs/apps/{id}/page.md and catalog/catalog.json in the submodule (one row per app id — older versions are removed from the catalog index).
  4. Runs python3 generator/build-site.py.
  5. Optionally deploys Firebase hosting.

Git workflow

  1. Commit catalog + handbook changes in forge-fleet.
  2. Bump forge-fleet submodule pointer in forge-fleet-website.
  3. Commit built website/ output in forge-fleet-website.

Verify

  • https://fleet.forgesdlc.com/catalog/catalog.json lists the app with correct sha256.
  • Handbook page renders at the handbook_page slug.
  • Zip downloads from download_url.
  • Running Fleet can POST /v1/fleet-apps/install successfully.

See also