Skip to content

GH#12740: tighten cloudron-app-publishing-skill.md to 150 lines #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johnwaldo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH#12740: tighten cloudron-app-publishing-skill.md to 150 lines #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 2 additions & 30 deletions .agents/tools/deployment/cloudron-app-publishing-skill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ Distribute Cloudron apps independently using a `CloudronVersions.json` version c

<!-- AI-CONTEXT-END -->

## Prerequisites

The app must be built and pushed to a registry with `cloudron build`. On-server builds (`cloudron install` without `--image`) do not produce registry-hosted images and cannot be published.

## Workflow

```bash
Expand All @@ -47,7 +43,7 @@ cloudron versions add # add version to catalog
cloudron versions init
```

Creates `CloudronVersions.json` in the package directory. Also adds missing publishing fields to `CloudronManifest.json` with placeholder values and creates stub files:
Creates `CloudronVersions.json` and adds missing publishing fields to `CloudronManifest.json` with placeholder values. Also creates stub files:

- `DESCRIPTION.md` -- detailed app description
- `CHANGELOG` -- version changelog
Expand All @@ -57,8 +53,6 @@ Edit all placeholders and stubs before adding a version.

### Required Manifest Fields for Publishing

Beyond what `cloudron init` provides, publishing requires:

| Field | Example |
|-------|---------|
| `id` | `com.example.myapp` |
Expand All @@ -78,14 +72,8 @@ Beyond what `cloudron init` provides, publishing requires:
| `postInstallMessage` | `file://POSTINSTALL.md` |
| `minBoxVersion` | `9.1.0` |

`cloudron versions init` scaffolds all of these with defaults.

## Build Commands

### cloudron build

Builds the Docker image. Behavior depends on whether a build service is configured:

```bash
cloudron build # build (local or remote)
cloudron build --no-cache # rebuild without Docker cache
Expand All @@ -96,8 +84,6 @@ cloudron build --build-arg KEY=VALUE # pass Docker build args

On first run, prompts for the Docker repository (e.g. `registry/username/myapp`). Remembers it for subsequent runs.

### Other Build Subcommands

| Command | Purpose |
|---------|---------|
| `cloudron build reset` | Clear saved repository, image, and build info |
Expand Down Expand Up @@ -134,7 +120,7 @@ Updates an existing version entry. Primarily used to change the publish state.
cloudron versions update --version 1.0.0 --state published
```

Avoid changing the manifest or image of a published version -- users may have already installed it. To ship changes, revoke the existing version and add a new one.
Avoid changing the manifest or image of a published version -- users may have already installed it. To ship changes, revoke and add a new version.

### cloudron versions revoke

Expand All @@ -155,20 +141,6 @@ Users install in two ways:
- **Dashboard** -- Add the URL under Community apps in the dashboard settings. Updates appear automatically.
- **CLI** -- `cloudron install --versions-url <url>`

## Typical Release Cycle

```bash
# 1. Edit code, bump version in CloudronManifest.json
# 2. Build and push
cloudron build

# 3. Add to catalog
cloudron versions add

# 4. Commit and push CloudronVersions.json to hosting
git add CloudronVersions.json && git commit -m "release 1.1.0" && git push
```

## Community Packages (9.1+)

Community packages can be non-free (paid). The package publisher can keep Docker images private, and the end user sets up a [private Docker registry](https://docs.cloudron.io/docker#private-registry) to access the package. Automation of purchase/discovery is outside Cloudron's scope.
Expand Down
Loading