Scaffold Cloudron packaging workspace
This commit is contained in:
20
templates/cloudron-app/README.md.j2
Normal file
20
templates/cloudron-app/README.md.j2
Normal file
@@ -0,0 +1,20 @@
|
||||
# {{ app_title }} on Cloudron
|
||||
|
||||
- **Upstream repository**: {{ app_repo }}
|
||||
- **Implementation issue**: {{ app_issue }}
|
||||
- **Generated**: {{ generated_at }} UTC
|
||||
|
||||
## Packaging Checklist
|
||||
|
||||
1. Map upstream services (databases, caches, workers) to Cloudron addons; remove unused entries from `optionalAddons` and enable required ones under `addons`.
|
||||
2. Implement the multi-stage build in `Dockerfile` to fetch/compile the correct release of {{ app_title }}.
|
||||
3. Update `start.sh` to configure the app from Cloudron environment variables and launch the primary process.
|
||||
4. Replace the placeholder health checks and smoke test with real coverage.
|
||||
5. Complete `CloudronManifest.json` (tagline, description, versioning, resource limits, ingress, TCP ports, etc.).
|
||||
6. Document manual configuration steps, migrations, and known gaps below.
|
||||
|
||||
## Notes
|
||||
|
||||
- Populate the `app/` directory with runtime overlays or artifacts generated during the build stage.
|
||||
- Use the shared packaging container (`docker/packager`) for `cloudron build/install` to keep the host clean.
|
||||
- Record decisions and operational requirements under `docs/apps/{{ app_slug }}/` as work progresses.
|
Reference in New Issue
Block a user