Set up porter.yaml

1. Create a porter.yaml file in your repository. You are not restricted to this exact name - you can use any custom name for your configuration file. For multiple environments, you might create separate files like:

• porter.prod.yaml

• porter.staging.yaml

• porter.preview.yaml

2. Reference your configuration file in your GitHub workflow file by adding -f /path/to/your-file.yaml to the end of the line with exec porter apply. If you use a custom name, ensure to reference it explicitly with the correct path. The configuration in this file will take precedence over dashboard settings.

3. Ensure your porter.yaml file contains a complete configuration for your application, as partial configurations are not currently supported.

Usage

When using porter.yaml files:

• Any changes pushed to the porter.yaml file will automatically update your application configuration when deployments occur.

• The porter.yaml file acts as the source of truth for your application configuration when referenced in your GitHub workflow.

• While you can make changes in the dashboard, the porter.yaml configuration will always take precedence during deployments.

• If you prefer to manage configuration through the dashboard instead, you can remove the porter.yaml reference from your GitHub workflow file.