Branch
Properties
| Property | Description | Values | Example |
|---|---|---|---|
namestring | name of the app branch | ✅ Required | - |
connected_repoConnectedRepoConfig | connected GitHub repo the branch tracks | Optional | - |
public_repoPublicRepoConfig | public git repo the branch tracks | Optional | - |
install_groupsarray | ordered deployment groups for this branch | Optional | - |
previewAppBranchPreviewConfig | default preview run settings for this branch | Optional | - |
post_deploy_runbooksarray | names of runbooks to run on each install, in order, after its deploy succeeds; resolved to IDs at sync time | Optional | - |
ignore_changes_regexstring | RE2 regex matched against every changed file path; a run whose entire changed file set matches is not attempted | Optional | - |
send_statuses_on_ignoreboolean | whether to send a successful commit status when a run is ignored by ignore_changes_regex | Optional | - |
connected_repo
| Property | Description | Values | Example |
|---|---|---|---|
repostring | repository identifier Identifier of the connected repository configured in the Nuon platform | ✅ Required | "my-repo", "production-infrastructure" |
directorystring | directory path Path within the repository to the configuration files | ✅ Required | "terraform", "infra/terraform" |
branchstring | Git branch Git branch to checkout and use for deployments | ✅ Required | "main", "develop", "production" |
public_repo
| Property | Description | Values | Example |
|---|---|---|---|
repostring | repository URL HTTPS URL to the public Git repository | ✅ Required | "https://github.com/user/repo.git", "https://github.com/user/terraform-modules.git" |
directorystring | directory path Path within the repository to the configuration files | ✅ Required | "terraform", "infra/terraform" |
branchstring | Git branch Git branch to checkout and use for deployments | ✅ Required | "main", "develop", "production" |
install_groups
| Property | Description | Values | Example |
|---|---|---|---|
namestring | name of the install group | ✅ Required | - |
orderinteger | deployment order (lower runs first) | Optional | - |
install_idsarray | static list of install IDs | Optional | - |
install_namesarray | static list of install names, resolved to IDs at sync time | Optional | - |
label_selectorobject | label key-value pairs to dynamically match installs | Optional | - |
auto_approve_on_policies_passingboolean | Auto-approve this group’s plan when all policy checks pass. Defaults to false | Optional | - |
preview
| Property | Description | Values | Example |
|---|---|---|---|
modestring | preview run mode: plan-only, apply, or build-only | Optional | - |
install_idstring | default install ID for preview runs | Optional | - |
install_namestring | default install name for preview runs, resolved to an ID at sync time | Optional | - |
label_selectorobject | label key-value pairs to select the default preview install | Optional | - |
set_statusesboolean | whether to set GitHub commit statuses for preview runs | Optional | - |
commentboolean | whether to comment on the pull request with preview results | Optional | - |