diff --git a/content/en/docs/help/deprecations.md b/content/en/docs/help/deprecations.md index 15d72a579..d536d7ad5 100644 --- a/content/en/docs/help/deprecations.md +++ b/content/en/docs/help/deprecations.md @@ -15,44 +15,58 @@ toc: true This page tracks deprecation notices for Updatecli and related projects, with migration guidance when relevant. -## updatecli-action - -### Deprecated branches `v1` and `v2` - -The `v1` and `v2` branches of `updatecli/updatecli-action` are deprecated and -will be removed soon. +## Updatecli -Use a released GitHub Action version instead, or track the `main` branch if you -explicitly want the branch tip. -You can migrate repositories to the latest GitHub Action version with the -following Updatecli policy: +### v0.120.0 -#### `.updatecli-compose.yaml` +#### `json` - `csv` - `toml`: Dasel v3 -```yaml -# export UPDATECLI_GITHUB_TOKEN= -# export UPDATECLI_GITHUB_USERNAME= -# updatecli compose diff --file updatecli-compose.yaml -# updatecli compose apply --file updatecli-compose.yaml +In version `v0.120.0`, the three plugins `json`, `csv`, and `toml` deprecate the dasel v1 and v2 syntax in favor of the dasel v3 syntax. +To ensure backward compatibility, the dasel v2 syntax will continue to work for now but it's recommended to migrate to the dasel v3 as soon as possible. -valuesinline: - scm: - enabled: true - kind: githubsearch - search: | - org: - archived:false - branch: "^main$|^master$" # branch accepts regular expressions - email: - limit: 0 # zero means no repository limit + + + + + + + + + + + + + +
BeforeAfter
+
+          actions:
+sources:
+  local:
+    name: Get value from json
+    kind: json
+    spec:
+      file: data.json
+      key: firstName
+          
+        
+
+
+          actions:
+sources:
+  local:
+    name: Get value from json
+    kind: json
+    spec:
+      file: data.json
+      key: firstName
+      engine: dasel/v3
+          
+        
+
-policies: - - name: Update Updatecli GitHub action version - policy: ghcr.io/updatecli/policies/updatecli/githubaction:0.8.1 -``` +Please be aware the the Dasel v3 syntax is a very rich syntax and not backward compatibility with the Dasel v2 syntax. For more information, please refer to the [Dasel v3 documentation](https://daseldocs.tomwright.me/). -## Updatecli ### v0.116.0 @@ -88,3 +102,40 @@ In Updatecli `v0.116.0`, the parameter `spec.automerge` for the action kind + +## updatecli-action + +### Deprecated branches `v1` and `v2` + +The `v1` and `v2` branches of `updatecli/updatecli-action` are deprecated and +will be removed soon. + +Use a released GitHub Action version instead, or track the `main` branch if you +explicitly want the branch tip. + +You can migrate repositories to the latest GitHub Action version with the +following Updatecli policy: + +#### `.updatecli-compose.yaml` + +```yaml +# export UPDATECLI_GITHUB_TOKEN= +# export UPDATECLI_GITHUB_USERNAME= +# updatecli compose diff --file updatecli-compose.yaml +# updatecli compose apply --file updatecli-compose.yaml + +valuesinline: + scm: + enabled: true + kind: githubsearch + search: | + org: + archived:false + branch: "^main$|^master$" # branch accepts regular expressions + email: + limit: 0 # zero means no repository limit + +policies: + - name: Update Updatecli GitHub action version + policy: ghcr.io/updatecli/policies/updatecli/githubaction:0.8.1 +```