| version | Version of the Ontrack CLI to setup (defaults to the latest) | no | "" |
| only-for | Repository owner for which to activate the Ontrack setup.
This is useful when the Ontrack setup can only be done for a given organisation or user.
| no | "" |
| url | URL of the Ontrack instance to target | no | "" |
| token | Authentication token to use to connect to Ontrack (required if URL is set) | no | "" |
| name | Optional name of the configuration to create | no | prod |
| config | Name of the GitHub configuration to use | no | — |
| indexation | Indexation interval of the GitHub repository in GitHub (in minutes) | no | 0 |
| github-token | GitHub token to use to get the latest version of the CLI (when version is not provided) | no | — |
| auto-validation-stamps | Sets the Ontrack project to create validation stamps on demand.
Value can be:
* true or "true" - auto creation based on predefined validation stamps
* "force" - auto creation even if no predefined validation stamps
* otherwise, no auto creation
| no | — |
| auto-promotion-levels | Sets the Ontrack project to create promotion levels on demand.
| no | — |
| promotions | Path to a local YAML file describing the promotions and their auto promotions.
For example:
promotions: ./.github/ontrack/promotions.yml
The file is expected to have the following structure:
PROMOTION:
validations:
- STAMP
promotions:
- PROMOTION
For example:
BRONZE:
validations:
- BUILD
SILVER:
validations:
- ACCEPTANCE
promotions:
- BRONZE
All validations and promotions are created if needed.
| no | — |
| issue-service | Identifier of the issue to be used.
For example:
* self - the GitHub issues
* jira//JiraConfig - to use a Jira server identified by the "JiraConfig" Jira configuration in Yontrack
| no | self |
| conn-retry-count | Max connection retry attempts for each call to Yontrack | no | "" |
| conn-retry-wait | Max connection retry wait time between attempts in seconds | no | "" |
| branch | Overrides branch name calculated from github.ref | no | "" |
| config-file-path | Path of the Yontrack configuration file | no | "" |