> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nuon.co/llms.txt
> Use this file to discover all available pages before exploring further.

> JSON Schema reference for branch configuration

# Branch

# Branch

## Properties

| Property                                                         | Description                               | Values         | Example |
| ---------------------------------------------------------------- | ----------------------------------------- | -------------- | ------- |
| **`name`**<br />string                                           | name of the app branch                    | **✅ Required** | -       |
| **`connected_repo`**<br />[ConnectedRepoConfig](#connected_repo) | connected GitHub repo the branch tracks   | **Optional**   | -       |
| **`public_repo`**<br />[PublicRepoConfig](#public_repo)          | public git repo the branch tracks         | **Optional**   | -       |
| **`install_groups`**<br />[array](#install_groups)               | ordered deployment groups for this branch | **Optional**   | -       |

### `connected_repo`

| Property                    | Description                                                                                  | Values         | Example                                    |
| --------------------------- | -------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------ |
| **`repo`**<br />string      | repository identifier Identifier of the connected repository configured in the Nuon platform | **✅ Required** | `"my-repo"`, `"production-infrastructure"` |
| **`directory`**<br />string | directory path Path within the repository to the configuration files                         | **✅ Required** | `"terraform"`, `"infra/terraform"`         |
| **`branch`**<br />string    | Git branch Git branch to checkout and use for deployments                                    | **✅ Required** | `"main"`, `"develop"`, `"production"`      |

### `public_repo`

| Property                    | Description                                                          | Values         | Example                                                                                 |
| --------------------------- | -------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------- |
| **`repo`**<br />string      | repository URL HTTPS URL to the public Git repository                | **✅ Required** | `"https://github.com/user/repo.git"`, `"https://github.com/user/terraform-modules.git"` |
| **`directory`**<br />string | directory path Path within the repository to the configuration files | **✅ Required** | `"terraform"`, `"infra/terraform"`                                                      |
| **`branch`**<br />string    | Git branch Git branch to checkout and use for deployments            | **✅ Required** | `"main"`, `"develop"`, `"production"`                                                   |

### `install_groups`

| Property                            | Description                                                | Values         | Example |
| ----------------------------------- | ---------------------------------------------------------- | -------------- | ------- |
| **`name`**<br />string              | name of the install group                                  | **✅ Required** | -       |
| **`order`**<br />integer            | deployment order (lower runs first)                        | **Optional**   | -       |
| **`use_for_previews`**<br />boolean | use this group for plan-only preview runs                  | **Optional**   | -       |
| **`install_ids`**<br />array        | static list of install IDs                                 | **Optional**   | -       |
| **`install_names`**<br />array      | static list of install names, resolved to IDs at sync time | **Optional**   | -       |
| **`label_selector`**<br />object    | label key-value pairs to dynamically match installs        | **Optional**   | -       |