Skip to content

Update promotion docs #1359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2025
+8 −4
Merged

Update promotion docs #1359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions _docs/promotions/promotion-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,10 @@ Code samples and internal references use `isc`.
| Environments |N/A | None |
| Product |`isc/resources/configuration/products` | Git user token |
| Applications |Git Source associated with Runtime | Git user token |
| Promotion Flow |`isc/configuration/promotion-flows`| Git user token |
| Promotion Policy |`isc/configuration/promotion-policies`| Git user token |
| Promotion Flow |`isc/resources/configuration/promotion-flows`| Git user token |
| Promotion Policy |`isc/resources/configuration/promotion-policies`| Git user token |
| Promotion Workflows |`isc/resources/control-planes/promotion-workflows` |Git user token |
| Promotion Template |`isc/configuration/promotion-templates`| N/A |
| Promotion Template |`isc/resources/configuration/promotion-templates`| N/A |



Expand Down
6 changes: 5 additions & 1 deletion _docs/promotions/yaml/promotion-template-crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ kind: PromotionTemplate
metadata:
name: base-helm # any valid k8s name
spec:
applicationSourceSelector:
matchLabels:
codefresh.io/product: loans
priority: 1
versionSource: # get release version from this file
file: Chart.yaml
jsonPath: $appVersion
Expand Down Expand Up @@ -52,7 +56,7 @@ spec:
| `spec.applicationSourceSelector` | The label used to match the application to which to apply the Promotion Template. Application selectors conform to Kubernetes _label selectors_, defined as `matchLabels` with `key-value` pairs, `matchExpressions` with `key-operator-value` arrays, or a combination of both. The values identify all the Promotion Template manifests that match the specific application or applications within the target environment.| - | Required|
| `spec.applicationSourceSelector.matchLabels` | One or more `key-value` pairs, where each pair is equivalent to a condition in `matchExpressions`. If there are multiple `key-value` pairs, the AND operator is used. <br>For example:{::nomarkdown}<ul><li><code class="highlighter-rouge">codefresh.io/environment: production</code> applies the Promotion Template to all applications within the Production Environment.</li><li><code class="highlighter-rouge">codefresh.io/product: loans</code> applies the Promotion Template only to applications belonging to the Loans product.</li></ul>{:/}| object | Optional |
| `spec.applicationSourceSelector.matchExpressions` | List of expressions, each with a `key`, an `operator`, and a set of `values`. <br>The `operator` defines the relationship between the `key` and its `values`, and can be one of the following: {::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: The value _must match_ one of those specified in the <code class="highlighter-rouge">values</code> array.</li> <li><code class="highlighter-rouge">NotIn</code>: The value _must NOT match_ any of those in the <code class="highlighter-rouge">values</code> array.</li><li><code class="highlighter-rouge">Exists</code>: Only the <code class="highlighter-rouge">key</code> must exist regardless of its values.<br>The <code class="highlighter-rouge">values</code> array must be empty. </li><li><code class="highlighter-rouge">DoesNotExist</code>: The <code class="highlighter-rouge">key</code> must not exist.<br>The <code class="highlighter-rouge">values</code> array must be empty.</li></ul>{:/}For example:<br>`key: codefresh.io/product` and `operator: Exists` applies the Promotion Template to any application containing the label `codefresh.io/product`.| string | Optional |
| `spec.priority` | The priority of the Promotion Template, determining the order in which Promotion Templates are applied when multiple Promotion Templates match the same application. The priority is ranked in ascending order, ranging from 0 or a negative number to higher values. |integer |Optional|
| `spec.priority` | The priority of the Promotion Template, determining the order in which Promotion Templates are applied when multiple Promotion Templates match the same application. The priority is ranked in ascending order, ranging from 0 or a negative number to higher values. |integer | Required |
| `spec.versionSource` | The location of the file and the attribute in the file from which to extract the product's application release version. This is the version displayed in the Product, Environment, and GitOps Apps dashboards.| - |Required |
| `spec.versionSource.file` | The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
| `spec.versionSource.jsonPath` | The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |
Expand Down