You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/products/configure-product-settings.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -173,6 +173,8 @@ Adding labels to a product lets you create access control rules that govern manu
173
173
Automate and orchestrate promotions across different environments for the product by:
174
174
* Selecting one or more predefined Promotion Flows
175
175
* Customizing the conditions to trigger each Promotion Flow
176
+
Commit messages for trigger conditions are not restricted to single words. You can specify any commit message to trigger promotions.
177
+
For example,`update image tag to v1.1` would be a valid commit message.
176
178
* Defining the priority for each Flow when multiple Flows are configured
177
179
178
180
@@ -186,9 +188,10 @@ Automate and orchestrate promotions across different environments for the produc
186
188
1. To add a Promotion Flow for the product, click**Add**.
187
189
1. From the list of Promotion Flows, select a predefined Flow for the product.
188
190
1. Define the conditions to match and trigger the Promotion Flow:
189
-
1.**Property**: The property to monitor for changes, based on either the text description associated with the commit message (`commitMessage`), or the commit hash generated by Git (`gitRevision`).
191
+
1.**Property**: The property to monitor for changes, based on either the text description associated with the commit message (`commitMessage`), or the commit hash generated by Git (`gitRevision`).
192
+
`commitMessage` can be a single or multiple words, or a set of words.
190
193
1.**Operator**: The operator to apply when matching the Property, based on inclusion or exclusion, with or without wildcards.
191
-
`In`: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values.
194
+
`In`: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values.Commit messages can include
192
195
`NotIn`: Checks if the commit message or Git revision <i>does not include</i> the specified value or any value within a set of values.
193
196
1.**Values**: Single or multiple values used to match or exclude Promotion Flows based on the Property and Operator configured.
194
197
1. To add more trigger conditions, click**Add** and repeat_steps 4.1 through 4.3_.
Copy file name to clipboardExpand all lines: _docs/products/promotion-flow-triggers.md
+34-9Lines changed: 34 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@ By selecting Promotion Flows for a product you can choose the most relevant flow
19
19
***Custom trigger conditions per flow**
20
20
Define specific trigger conditions for each Promotion Flow to tailor automated promotion based on the product’s unique deployment requirements.
21
21
For example, configure the trigger to launch the Hotfix flow whenever a commit message contains the phrase`hotfix`.
22
+
22
23
23
24
***Prioritization**
24
25
Arrange the Promotion Flows in a prioritized order to control the sequence in which they are evaluated and executed.
@@ -27,8 +28,18 @@ By selecting Promotion Flows for a product you can choose the most relevant flow
27
28
##Where to configure Promotion Flows and triggers
28
29
In**Product > Settings > Promotion Flows**.
29
30
Select one or more Promotion Flows for the product, and then configure custom conditions to trigger each of the flows.
30
-
See also[Promotion Flow CRD](#promotion-flow-yaml).
31
+
See also[Product CRD](#promotion-crd).
32
+
33
+
#####Commit messages & Git revisions
34
+
You can monitor changes based on the commit message (`commitMessage`) or the Git revision (`gitRevision`).
35
+
The commit message can include single words, multiple words, or phrases. For example,`hotfix` or`update image to v1.2`. There are no restrictions on commit messages.
36
+
37
+
31
38
39
+
#####Matching operators for filtering commits
40
+
Operators define how commit messages or Git revisions are matched:
41
+
*`In`: Includes the specified value or any value from a set.
42
+
*`NotIn`: Excludes the specified value or any value from a set.
32
43
33
44
{% include
34
45
image.html
@@ -41,7 +52,7 @@ See also [Promotion Flow CRD](#promotion-flow-yaml).
41
52
%}
42
53
43
54
44
-
For how to instructions on selecting Promotion Flows for products, see[Select Promotion Flows forProducts]({{site.baseurl}}/docs/products/configure-product-settings/#select-promotion-flows-for-products).
55
+
For how to instructions on selecting Promotion Flows for products, see[Select Promotion Flows forproducts]({{site.baseurl}}/docs/products/configure-product-settings/#select-promotion-flows-for-products).
45
56
46
57
47
58
##Examples of trigger conditions for Promotion Flows
@@ -63,20 +74,32 @@ The Hotfix flow is designed for urgent fixes that need to be deployed quickly, t
63
74
64
75
The Hotfix flow triggers when the`commit message` contains either`hotfix` or`patch`, ensuring that only critical changes labeled trigger the flow.
65
76
77
+
###Commit message-based Promotion Flow
78
+
79
+
The Commit message based Promotion Flow triggers the promotion when the message contains a specific phrase.
80
+
81
+
{: .table .table-bordered .table-hover}
82
+
|**Trigger condition**|**Setting**|
83
+
|----------------------|------------------|
84
+
|**Property**|`commitMessage`|
85
+
|**Operator**|`In`|
86
+
|**Values**|`bump Kubernetes version`|
87
+
88
+
This type of trigger monitors the commit message and triggers the promotion when the message contains a specific phrase. This is useful when you follow commit conventions like`bump version`,`update dependency` for example.
66
89
67
90
###Feature branch Promotion Flow
68
91
69
92
The Feature branch flow is designed for promoting new features from development to testing/staging environments.
70
93
71
-
72
94
{: .table .table-bordered .table-hover}
73
95
|**Trigger condition**|**Setting**|
74
96
|----------------------|------------------|
75
97
|**Property**|`gitRevision`|
76
98
|**Operator**|`In`|
77
99
|**Values**|`feature/*`|
78
100
79
-
The Feature branch flow triggers when the Git revision matches a feature branch pattern, such as`feature/*`. This ensures that only feature branches are promoted to the testing environment.
101
+
102
+
This Feature branch flow triggers when the commit message matches the phrase`Bump Kubernetes version`. Any commit message that includes Bump Kubernetes version (exact phrase match) will trigger the promotion.
80
103
81
104
###Multi-region Promotion Flow
82
105
The Multi-region flow is designed to first deploy to several regional environments for validation before final deployment to production.
@@ -122,9 +145,10 @@ The Rollback flow is designed to revert changes when issue are detected in produ
122
145
123
146
The Rollback flow triggers when the commit message contains terms like`revert` or`rollback`, ensuring that the flow is triggered only for rollback operations.
124
147
125
-
##Promotion Flow YAML
148
+
<!---
149
+
## Product YAML
126
150
127
-
ConfigurePromotion Flow settings in either Form or YAML modes.
151
+
Configureproduct settings in either Form or YAML modes.
128
152
129
153
Once configured and committed, these settings are saved as the `promotion-flow` resource within the Shared Configuration Repository in the GitOps Runtime selected as the Configuration Runtime.
130
154
@@ -133,11 +157,12 @@ See [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/
133
157
134
158
To configure directly in YAML, refer to our [Promotion Flow YAML]({{site.baseurl}}/docs/promotions/yaml/promotion-flow-crd/) for the syntax requirements and descriptions.