Merge pull request #34 from v1v/feature/support-opt-out-scm-email

feat: opt-out scm.email
updatecli · Sep 13, 2024 · e68daf2 · e68daf2
2 parents bbab87a + 6e4f2e8
commit e68daf2
Show file tree

Hide file tree

Showing 94 changed files with 239 additions and 44 deletions.
diff --git a/.ci/scripts/release.bash b/.ci/scripts/release.bash
@@ -34,8 +34,7 @@ function runUpdatecliDiff(){
   updatecli diff \
     --config "$POLICY_ROOT_DIR/updatecli.d" \
     --values "$POLICY_ROOT_DIR/values.yaml" \
-    --values "$POLICY_ROOT_DIR/testdata/values.yaml" \
-    --experimental
+    --values "$POLICY_ROOT_DIR/testdata/values.yaml"
 }
 
 function validateRequiredFile(){
@@ -119,6 +118,16 @@ function validateRequiredFile(){
     POLICY_ERROR=true
     echo "  * Changelog missing a version entry such as '## $versionInformation' in $POLICY_CHANGELOG"
   fi
+
+  # Testing that the latest changelog version is used in the Policy.yaml
+  latestVersionChangelogEntry=$( grep -r '## ' -m 1 "$POLICY_CHANGELOG")
+  latestVersionChangelogEntry=${latestVersionChangelogEntry#"## "}
+  if [[ "$latestVersionChangelogEntry" != "$versionInformation" ]]; then
+    POLICY_ERROR=true
+    echo "  * Latest Changelog version isn't the one used in Policy.yaml"
+    echo "      '## $latestVersionChangelogEntry' in $POLICY_CHANGELOG"
+    echo "      '## $versionInformation' in $POLICY_METADATA"
+  fi
 }
 
 function main(){
@@ -134,20 +143,21 @@ function main(){
     POLICY_ROOT_DIR=$(dirname "$POLICY")
     POLICY_ERROR=false
 
+    if [[ "$PARAM" == "--e2e-test" ]]; then
+      runUpdatecliDiff "$POLICY_ROOT_DIR"
+    fi
+
+    if [[ "$PARAM" == "--unit-test" ||  "$PARAM" == "" ]]; then
+      validateRequiredFile "$POLICY_ROOT_DIR"
+    fi
+
     if [[ "$POLICY_ERROR" = "false" ]]; then
       echo "  => all is good"
 
       if [[ "$PARAM" == "--publish" ]]; then
         release "$POLICY_ROOT_DIR"
       fi
 
-      if [[ "$PARAM" == "--e2e-test" ]]; then
-        runUpdatecliDiff "$POLICY_ROOT_DIR"
-      fi
-
-      if [[ "$PARAM" == "--unit-test" ||  "$PARAM" == "" ]]; then
-        validateRequiredFile "$POLICY_ROOT_DIR"
-      fi
     else
       echo ""
       echo "  => validation test not passing"
@@ -161,3 +171,4 @@ function main(){
 }
 
 main "${1:-}"
+
diff --git a/updatecli/policies/autodiscovery/all/CHANGELOG.md b/updatecli/policies/autodiscovery/all/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog 
 
+## 0.7.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.6.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/all/Policy.yaml b/updatecli/policies/autodiscovery/all/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/all/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/all/"
-version: 0.6.0
+version: 0.7.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/all/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/all/updatecli.d/default.tpl
@@ -44,7 +44,9 @@ scms:
       # {{ $GitHubUser := env ""}}
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       # {{ $GitHubRepositoryList := env "GITHUB_REPOSITORY" | split "/"}}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'

diff --git a/updatecli/policies/autodiscovery/cargo/CHANGELOG.md b/updatecli/policies/autodiscovery/cargo/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/cargo/Policy.yaml b/updatecli/policies/autodiscovery/cargo/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/cargo/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/cargo/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/cargo/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/cargo/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/dockercompose/CHANGELOG.md b/updatecli/policies/autodiscovery/dockercompose/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/dockercompose/Policy.yaml b/updatecli/policies/autodiscovery/dockercompose/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/dockercompose/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/dockercompose/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/dockercompose/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/dockercompose/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/dockerfile/CHANGELOG.md b/updatecli/policies/autodiscovery/dockerfile/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/dockerfile/Policy.yaml b/updatecli/policies/autodiscovery/dockerfile/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/dockerfile/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/dockerfile/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/dockerfile/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/dockerfile/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/flux/CHANGELOG.md b/updatecli/policies/autodiscovery/flux/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/flux/Policy.yaml b/updatecli/policies/autodiscovery/flux/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/flux/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/flux/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/flux/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/flux/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/golang/CHANGELOG.md b/updatecli/policies/autodiscovery/golang/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.8.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/golang/Policy.yaml b/updatecli/policies/autodiscovery/golang/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/golang/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/golang/"
-version: 0.8.0
+version: 0.9.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/golang/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/golang/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user}}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository}}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/helm/CHANGELOG.md b/updatecli/policies/autodiscovery/helm/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/helm/Policy.yaml b/updatecli/policies/autodiscovery/helm/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/helm/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/helm/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/helm/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/helm/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/helmfile/CHANGELOG.md b/updatecli/policies/autodiscovery/helmfile/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/helmfile/Policy.yaml b/updatecli/policies/autodiscovery/helmfile/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/helmfile/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/helmfile/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/helmfile/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/helmfile/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/ko/CHANGELOG.md b/updatecli/policies/autodiscovery/ko/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/ko/Policy.yaml b/updatecli/policies/autodiscovery/ko/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/ko/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/ko/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/ko/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/ko/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/kubernetes/CHANGELOG.md b/updatecli/policies/autodiscovery/kubernetes/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/kubernetes/Policy.yaml b/updatecli/policies/autodiscovery/kubernetes/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/kubernetes/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/kubernetes/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/kubernetes/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/kubernetes/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/maven/CHANGELOG.md b/updatecli/policies/autodiscovery/maven/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.4.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/maven/Policy.yaml b/updatecli/policies/autodiscovery/maven/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/maven/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/maven/"
-version: 0.4.0
+version: 0.5.0
 vendor: Updatecli Project
 
 licenses:

diff --git a/updatecli/policies/autodiscovery/maven/updatecli.d/default.tpl b/updatecli/policies/autodiscovery/maven/updatecli.d/default.tpl
@@ -28,7 +28,9 @@ scms:
     spec:
       # Priority set to the environment variable
       user: '{{ default $GitHubUser .scm.user }}'
+# {{ if .scm.email }}
       email: '{{ .scm.email }}'
+# {{ end }}
       owner: '{{ default $GitHubRepositoryList._0 .scm.owner }}'
       repository: '{{ default $GitHubRepositoryList._1 .scm.repository }}'
       token: '{{ default $GitHubPAT .scm.token }}'

diff --git a/updatecli/policies/autodiscovery/npm/CHANGELOG.md b/updatecli/policies/autodiscovery/npm/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.10.0
+
+* Allow to opt out `scm.email`.
+
 ## 0.9.0
 
 * Allow to set commit with GitHub GraphQL API using `scm.commitusingapi`

diff --git a/updatecli/policies/autodiscovery/npm/Policy.yaml b/updatecli/policies/autodiscovery/npm/Policy.yaml
@@ -4,7 +4,7 @@ authors:
 url: "https://github.com/updatecli/policies/"
 documentation: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/npm/README.md"
 source: "https://github.com/updatecli/policies/tree/main/updatecli/policies/autodiscovery/npm/"
-version: 0.9.0
+version: 0.10.0
 vendor: Updatecli Project
 
 licenses: