Skip to content

docs: document per-block validation and legacy addon warning for porter apply #335

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
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document per-block validation and legacy addon warning for porter apply #335

Show file tree
Hide file tree
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
11 changes: 11 additions & 0 deletions applications/configuration-as-code/addons-porter-yaml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,14 @@ addons:
ramMegabytes: 110
```

## Validating multi-app/addon porter.yaml

Run `porter apply validate` (or `porter apply --validate`) to check a multi-app/addon `porter.yaml` before deploying. Each app and addon block under `apps:` and `addons:` is split out and validated individually, and the command fails on the first invalid block and reports its index in the array.

```bash
porter apply validate -f porter.yaml
```

<Warning>
Addon blocks that use the deprecated legacy schema are skipped during validation and print a yellow `DEPRECATION WARNING`. The command still succeeds for the rest of the file, but legacy addon support will be removed in a future release. Update those addons to the current schema so they're covered by validation.
</Warning>
12 changes: 12 additions & 0 deletions standard/cli/command-reference/porter-apply.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ You can pass environment variables and secrets directly via command-line flags w
| `--validate` | Check that the `porter.yaml` file is valid YAML syntax |
| `--dry-run` | Perform server-side validation to confirm the configuration is valid without applying changes |

When you pass `--validate` (or run `porter apply validate`), Porter validates the file based on its format:

- **Single-app `porter.yaml`** — validated as one application configuration.
- **Multi-app/addon `porter.yaml`** (top-level `apps:` and/or `addons:` arrays) — each app and addon block is split out and validated individually. The command fails on the first invalid app or addon and reports its index in the array.
- **Legacy addon schemas** — addon blocks that use the deprecated legacy schema are skipped with a yellow `DEPRECATION WARNING`. Validation still succeeds for the rest of the file, but support for the legacy schema will be removed in a future release. Update the addon to the current schema to keep it covered by validation.

### Advanced Options

| Flag | Short | Description |
Expand Down Expand Up @@ -122,6 +128,12 @@ porter apply -f porter.yaml --preview
porter apply -f porter.yaml --validate
```

```bash Validate Multi-App/Addon YAML
# Validate every app and addon block in a multi-app porter.yaml individually.
# Legacy addon blocks are skipped with a deprecation warning.
porter apply validate -f porter.yaml
```

```bash Dry Run
# Validate the full configuration server-side without deploying
porter apply -f porter.yaml --dry-run
Expand Down