Merge pull request #1808 from lizardruss/profile-expressions

feat: allow variables and expression in profiles

Author: FabianKramm

docs/pages/configuration/expressions.mdx

@@ -129,6 +129,17 @@ Expressions are run in a golang shell that is syntax compatible to a regular POS
 Variables are resolved before and after applying expressions, which means that you can load a section from file within an expression that contains a variable which will still be resolved afterwards.
 :::
 
+:::warning Unsupported Config Expressions
+Expressions are not supported in these configuration properties:
+- `vars`
+- `profiles[*].name`
+- `profiles[*].parent`
+- `profiles[*].parents`
+- `profiles[*].activations`
+- `profiles[*].patches[*].op`
+- `profiles[*].patches[*].path`
+:::
+
 ### Testing Config Expressions
 
 The command `devspace print` can be used to test your config expressions and shows the config after all profiles, variables and expressions were applied.

docs/pages/configuration/profiles/activation.mdx

@@ -3,9 +3,27 @@ title: "Profiles: Activation"
 sidebar_label: activation
 ---
 
-The `activation` option is optional and allows you to activate a profile using regular expression matching of environment variables. An activation is configured with the profile it activates in `devspace.yaml`.
+The `activation` option is optional and allows you to activate a profile using regular expression matching of either Devspace or environment variables. An activation is configured with the profile it activates in `devspace.yaml`.
 
-#### Example: Defining a Profile Activation
+
+#### Example: Defining a Profile Activation using `vars`
+```yaml {1-3,7-8}
+vars:
+- name: ENV
+  default: development
+profiles:
+- name: production
+  activation:
+  - vars:
+      ENV: production
+  patches:
+  - op: replace
+    path: images.backend.image
+    value: john/prodbackend
+```
+The `production` profile would be activated when the Devspace variable `ENV` has value `production`.  In this example, it has a default value of `development`, so it is not activated unless you override the value using `--var ENV=production`
+
+#### Example: Defining a Profile Activation using Environment Variables
 ```yaml {3-5}
 profiles:
 - name: production
@@ -33,30 +51,35 @@ profiles:
 ```
 The profile `production` would be activated when the environment variable `ENV` matches the regular expression `prod-\d+`. This can be useful for matching environment variables that have dynamic values. Regular expressions will have start of string (`^`) and end of string (`$`) anchors added automatically to avoid unexpected substring matching. 
 
-#### Example: Matching All Environment Variables
-When multiple `env` name/expression pairs are specified in the same activation, all environment variables values must match the expression to activate the profile. For example, the `production` profile is activated when both environment variables match their expressions:
-```yaml {3-6}
+#### Example: Matching All
+When multiple `env` or `vars` name/expression pairs are specified in the same activation, all expressions must match to activate the profile. For example, the `production` profile is activated when the environment variable `CI` is `true` and the Devspace variable `ENV` is `development`:
+```yaml {3-7}
 profiles:
 - name: production
   activation:
   - env:
       CI: "true"
+    vars:
       ENV: "development"
   patches:
   - op: replace
     path: images.backend.image
     value: john/devbackend
 ```
 
-#### Example: Matching Any Environment Variables
-When environment variables are used in multiple activations, the profile is activated when any environment variable matches. In this example, the `production` profile is activated when either environment variables match their expressions:
+:::note Combining `env` and `vars`
+While possible to activate profiles using environment variables and Devspace variables, `vars` can also be populated through environment variables. In the above example, we could have also defined `CI` as a Devspace variable with `source: env` and only used `vars` in the activation.
+:::
+
+#### Example: Matching Any
+When `env` or `vars` are used in multiple activations, the profile is activated when any expression matches. In this example, the `production` profile is activated when either match their expressions:
 ```yaml {3-7}
 profiles:
 - name: production
   activation:
   - env:
       CI: "true"
-  - env:
+  - vars:
       ENV: "development"
   patches:
   - op: replace