Skip to content

Commit 5eea7a0

Browse files
authored
Add note to labels option in readmes (#472)
1 parent ad679a4 commit 5eea7a0

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

roles/job_templates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ This also speeds up the overall role.
108108
|`webhook_service`|""|no|str|Service that webhook requests will be accepted from (github, gitlab)|
109109
|`webhook_credential`|""|no|str|Personal Access Token for posting back the status to the service API|
110110
|`scm_branch`|""|no|str|Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.|
111-
|`labels`|""|no|list|The labels applied to this job template|
111+
|`labels`|""|no|list|The labels applied to this job template. NOTE: Labels must be created with the [labels](https://github.com/redhat-cop/controller_configuration/tree/devel/roles/labels) role first, an error will occur if the label supplied to this role does not exist.|
112112
|`custom_virtualenv`|""|no|str|Local absolute file path containing a custom Python virtualenv to use.|
113113
|`notification_templates_started`|""|no|list|The notifications on started to use for this organization in a list.|
114114
|`notification_templates_success`|""|no|list|The notifications on success to use for this organization in a list.|

roles/workflow_job_templates/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ This also speeds up the overall role.
7171
|`allow_simultaneous`|""|no|bool|Allow simultaneous runs of the workflow job template.|
7272
|`inventory`|""|no|str|Inventory applied as a prompt, assuming job template prompts for inventory|
7373
|`limit`|""|no|str|Limit applied as a prompt, assuming job template prompts for limit|
74-
|`labels`|""|no|str|The labels applied to this job template|
74+
|`labels`|""|no|str|The labels applied to this job template. NOTE: Labels must be created with the [labels](https://github.com/redhat-cop/controller_configuration/tree/devel/roles/labels) role first, an error will occur if the label supplied to this role does not exist.|
7575
|`ask_labels_on_launch`|""|no|bool|Prompt user for labels on launch.|
7676
|`job_tags`|""|no|str|Comma separated list of the tags to use for the workflow job template.|
7777
|`skip_tags`|""|no|str|Comma separated list of the tags to skip for the workflow job template.|
@@ -103,7 +103,7 @@ This also speeds up the overall role.
103103
|`forks`|Job Template default|no|str|Forks applied as a prompt. Job Template default used if not set. Only allowed if `ask_forks_on_launch` set to true on Job Template|
104104
|`instance_groups`|Job Template default|no|str| List of Instance Groups applied as a prompt. Job Template default used if not set. Only allowed if `ask_instance_groups_on_launch` set to true on Job Template|
105105
|`job_slice_count`|Job Template default|no|str|Job Slice Count to use in the job run. Job Template default used if not set. Only allowed if `ask_job_slice_count_on_launch` set to true on Job Template|
106-
|`labels`|Job Template default|no|list|List of labels to use in the job run. Job Template default used if not set. Only allowed if `ask_labels_on_launch` set to true on Job Template|
106+
|`labels`|Job Template default|no|list|List of labels to use in the job run. Job Template default used if not set. Only allowed if `ask_labels_on_launch` set to true on Job Template. NOTE: Labels must be created with the [labels](https://github.com/redhat-cop/controller_configuration/tree/devel/roles/labels) role first, an error will occur if the label supplied to this role does not exist.|
107107
|`timeout`|Job Template default|no|str|Timeout to use in the job run. Job Template default used if not set. Only allowed if `ask_timeout_on_launch` set to true on Job Template|
108108
|`approval_node`|""|no|str|A dictionary of Name, description, and timeout values for the approval node. This parameter is mutually exclusive with unified_job_template.|
109109
|`organization`|""|no|str|The organization of the workflow job template the node exists in. Used for looking up the workflow, not a direct model field.|

0 commit comments

Comments
 (0)