Merge branch 'maina' into fix-#7908-update-CSAT-skaffold-survey-to-be…

…-presented-1-weekly-cadence

.github/workflows/scorecards.yml

@@ -27,7 +27,7 @@ jobs:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@865b4092859256271290c77adbd10a43f4779972 # v2.0.0
+        uses: ossf/scorecard-action@e363bfca00e752f91de7b7d2a77340e2e523cb18 # v2.0.0
         with:
           results_file: results.sarif
           results_format: sarif

.gitignore

@@ -1,7 +1,9 @@
 bin/
 out/
 examples/bazel/bazel-*
+examples/**/.mvn/wrapper/maven-wrapper.jar
 integration/examples/bazel/bazel-*
+integration/**/.mvn/wrapper/maven-wrapper.jar
 integration/testdata/custom/bazel-*
 integration/testdata/plugin/local/bazel/bazel-*
 *.new

docs-v2/content/en/docs/references/api-v2/grpc.md

@@ -1213,6 +1213,11 @@ For Cancelled Error code, use range 800 to 850.<br>
 | RENDER_KPTFILE_INVALID_SCHEMA_ERR | 1402 | The Kptfile is not a valid API schema |
 | RENDER_SET_NAMESPACE_ERR | 1403 | Error setting namespace. |
 | RENDER_NAMESPACE_ALREADY_SET_ERR | 1404 | Namespace is already set. |
+| RENDER_REPLACE_IMAGE_ERR | 1405 | Error replacing a built artifact in the manifests |
+| RENDER_TRANSFORM_MANIFEST_ERR | 1406 | Error transforming a manifest during skaffold debug |
+| RENDER_SET_LABEL_ERR | 1407 | Error setting user specified additional labels. |
+| RENDER_MANIFEST_WRITE_ERR | 1408 | Error writing hydrated kubernetes manifests. |
+| RENDER_PARSE_MANIFEST_IMAGES_ERR | 1409 | Error getting images from a kubernetes manifest. |
 | CONFIG_FILE_PARSING_ERR | 1201 | Catch-all configuration file parsing error |
 | CONFIG_FILE_NOT_FOUND_ERR | 1202 | Main configuration file not found |
 | CONFIG_DEPENDENCY_NOT_FOUND_ERR | 1203 | Dependency configuration file not found |

docs-v2/content/en/docs/references/api/grpc.md

@@ -1068,6 +1068,11 @@ For Cancelled Error code, use range 800 to 850.<br>
 | RENDER_KPTFILE_INVALID_SCHEMA_ERR | 1402 | The Kptfile is not a valid API schema |
 | RENDER_SET_NAMESPACE_ERR | 1403 | Error setting namespace. |
 | RENDER_NAMESPACE_ALREADY_SET_ERR | 1404 | Namespace is already set. |
+| RENDER_REPLACE_IMAGE_ERR | 1405 | Error replacing a built artifact in the manifests |
+| RENDER_TRANSFORM_MANIFEST_ERR | 1406 | Error transforming a manifest during skaffold debug |
+| RENDER_SET_LABEL_ERR | 1407 | Error setting user specified additional labels. |
+| RENDER_MANIFEST_WRITE_ERR | 1408 | Error writing hydrated kubernetes manifests. |
+| RENDER_PARSE_MANIFEST_IMAGES_ERR | 1409 | Error getting images from a kubernetes manifest. |
 | CONFIG_FILE_PARSING_ERR | 1201 | Catch-all configuration file parsing error |
 | CONFIG_FILE_NOT_FOUND_ERR | 1202 | Main configuration file not found |
 | CONFIG_DEPENDENCY_NOT_FOUND_ERR | 1203 | Dependency configuration file not found |

docs-v2/layouts/partials/info-panel.html

@@ -9,6 +9,7 @@
 {{ $deploy := $data.deploy }}
 {{ $render := $data.render }}
 {{ $all := and $dev $debug $run $build $deploy $render }}
+{{ $examples := $data.examples }}
 
 <div class="alert infopanel" role="contentinfo">
     <table>
@@ -45,6 +46,17 @@
             </td>
         </tr>
         {{end}}
+
+        {{ if $examples}}
+        <tr>
+            <td><b>Code Samples</b></td>
+            <td>
+                {{ range $example := $examples }}
+                <a href="{{$example.url}}"><code>{{$example.name}}</code></a>
+                {{ end }}
+            </td>
+        </tr>
+        {{ end }}
     </table>
 </div>
 

docs/content/en/docs/references/api-v2/grpc.md

@@ -1213,6 +1213,11 @@ For Cancelled Error code, use range 800 to 850.<br>
 | RENDER_KPTFILE_INVALID_SCHEMA_ERR | 1402 | The Kptfile is not a valid API schema |
 | RENDER_SET_NAMESPACE_ERR | 1403 | Error setting namespace. |
 | RENDER_NAMESPACE_ALREADY_SET_ERR | 1404 | Namespace is already set. |
+| RENDER_REPLACE_IMAGE_ERR | 1405 | Error replacing a built artifact in the manifests |
+| RENDER_TRANSFORM_MANIFEST_ERR | 1406 | Error transforming a manifest during skaffold debug |
+| RENDER_SET_LABEL_ERR | 1407 | Error setting user specified additional labels. |
+| RENDER_MANIFEST_WRITE_ERR | 1408 | Error writing hydrated kubernetes manifests. |
+| RENDER_PARSE_MANIFEST_IMAGES_ERR | 1409 | Error getting images from a kubernetes manifest. |
 | CONFIG_FILE_PARSING_ERR | 1201 | Catch-all configuration file parsing error |
 | CONFIG_FILE_NOT_FOUND_ERR | 1202 | Main configuration file not found |
 | CONFIG_DEPENDENCY_NOT_FOUND_ERR | 1203 | Dependency configuration file not found |

docs/content/en/docs/references/api/grpc.md

@@ -1068,6 +1068,11 @@ For Cancelled Error code, use range 800 to 850.<br>
 | RENDER_KPTFILE_INVALID_SCHEMA_ERR | 1402 | The Kptfile is not a valid API schema |
 | RENDER_SET_NAMESPACE_ERR | 1403 | Error setting namespace. |
 | RENDER_NAMESPACE_ALREADY_SET_ERR | 1404 | Namespace is already set. |
+| RENDER_REPLACE_IMAGE_ERR | 1405 | Error replacing a built artifact in the manifests |
+| RENDER_TRANSFORM_MANIFEST_ERR | 1406 | Error transforming a manifest during skaffold debug |
+| RENDER_SET_LABEL_ERR | 1407 | Error setting user specified additional labels. |
+| RENDER_MANIFEST_WRITE_ERR | 1408 | Error writing hydrated kubernetes manifests. |
+| RENDER_PARSE_MANIFEST_IMAGES_ERR | 1409 | Error getting images from a kubernetes manifest. |
 | CONFIG_FILE_PARSING_ERR | 1201 | Catch-all configuration file parsing error |
 | CONFIG_FILE_NOT_FOUND_ERR | 1202 | Main configuration file not found |
 | CONFIG_DEPENDENCY_NOT_FOUND_ERR | 1203 | Dependency configuration file not found |

docs/data/maturity.json

@@ -19,7 +19,25 @@
     "area": "Build",
     "feature": "Cloud Native Buildpacks support",
     "maturity": "GA",
-    "description": "Skaffold natively support for artifacts built with Cloud Native Buildpacks"
+    "description": "Skaffold natively supports artifacts built with Cloud Native Buildpacks",
+    "examples": [
+      {
+        "name": "go buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks"
+      },
+      {
+        "name": "java buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks-java"
+      },
+      {
+        "name": "node buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks-node"
+      },
+      {
+        "name": "python buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks-python"
+      }
+    ]
   },
   "build.custom": {
     "dev": "x",
@@ -29,7 +47,17 @@
     "area": "Build",
     "feature": "custom artifact Builder",
     "maturity": "beta",
-    "description": "build locally using a custom build script "
+    "description": "build locally using a custom build script",
+    "examples": [
+      {
+        "name": "buildx",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/custom-buildx"
+      },
+      {
+        "name": "ko",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/custom"
+      }
+    ]
   },
   "build.dependencies": {
     "dev": "x",
@@ -49,7 +77,13 @@
     "area": "Build",
     "feature": "ko builder",
     "maturity": "alpha",
-    "description": "Build Go apps using ko"
+    "description": "Build Go apps using ko",
+    "examples": [
+      {
+        "name": "ko",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/ko"
+      }
+    ]
   },
   "build": {
     "dev": "x",
@@ -59,7 +93,49 @@
     "area": "Build",
     "maturity": "GA",
     "description": "Build images based on multiple build tools in a configurable way",
-    "url": "/docs/pipeline-stages/builders/"
+    "url": "/docs/pipeline-stages/builders/",
+    "examples": [
+      {
+        "name": "docker",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/docker-deploy"
+      },
+      {
+        "name": "jib/maven",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/jib"
+      },
+      {
+        "name": "jib/gradle",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/jib-gradle"
+      },
+      {
+        "name": "go buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks"
+      },
+      {
+        "name": "java buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks-java"
+      },
+      {
+        "name": "node buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks-node"
+      },
+      {
+        "name": "python buildpacks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/buildpacks-python"
+      },
+      {
+        "name": "bazel",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/bazel"
+      },
+      {
+        "name": "ko",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/ko"
+      },
+      {
+        "name": "buildx",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/custom-buildx"
+      }
+    ]
   },
   "completion": {
     "area": "Completion",
@@ -160,7 +236,25 @@
     "area": "Deploy",
     "maturity": "GA",
     "description": "Deploy a set of deployables as your applications and replace the image name with the built images ",
-    "url": "/docs/pipeline-stages/deployers"
+    "url": "/docs/pipeline-stages/deployers",
+    "examples": [
+      {
+        "name": "kubectl",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/getting-started"
+      },
+      {
+        "name": "helm",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/helm-deployment"
+      },
+      {
+        "name": "kustomize",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/kustomize"
+      },
+      {
+        "name": "docker",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/docker-deploy"
+      }
+    ]
   },
   "deploy.docker": {
     "dev": "x",
@@ -170,7 +264,13 @@
     "area": "Deploy",
     "feature": "Docker Deployer",
     "maturity": "beta",
-    "description": "Deploy applications to the local Docker daemon"
+    "description": "Deploy applications to the local Docker daemon",
+    "examples": [
+      {
+        "name": "docker",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/docker-deploy"
+      }
+    ]
   },
   "deploy.status_check": {
     "dev": "x",
@@ -268,7 +368,13 @@
     "area": "Lifecycle Hooks",
     "maturity": "alpha",
     "description": "Run code triggered by different events during the skaffold process lifecycle.",
-    "url": "/docs/pipeline-stages/lifecycle-hooks/"
+    "url": "/docs/pipeline-stages/lifecycle-hooks/",
+    "examples": [
+      {
+        "name": "hooks",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/lifecycle-hooks"
+      }
+    ]
   },
   "logging": {
     "dev": "x",
@@ -298,7 +404,17 @@
     "area": "Profiles",
     "maturity": "GA",
     "description": "Create different pipeline configurations based on overrides and patches defined in one or more profiles",
-    "url": "/docs/environment/profiles/"
+    "url": "/docs/environment/profiles/",
+    "examples": [
+      {
+        "name": "profiles",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/profiles"
+      },
+      {
+        "name": "profile patches",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/profile-patches"
+      }
+    ]
   },
   "render": {
     "deploy": "x",
@@ -345,14 +461,26 @@
     "area": "Tagpolicy",
     "maturity": "GA",
     "description": "Automated tagging",
-    "url": "/docs/pipeline-stages/taggers"
+    "url": "/docs/pipeline-stages/taggers",
+    "examples": [
+      {
+        "name": "envTemplate",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/tagging-with-environment-variables"
+      }
+    ]
   },
   "templating": {
     "deploy": "x",
     "area": "Templating",
     "maturity": "GA",
     "description": "certain fields of skaffold.yaml can be parametrized with environment and built-in variables",
-    "url": "/docs/environment/templating/"
+    "url": "/docs/environment/templating/",
+    "examples": [
+      {
+        "name": "templated fields",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/templated-fields"
+      }
+    ]
   },
   "test": {
     "dev": "x",
@@ -361,7 +489,17 @@
     "area": "Test",
     "maturity": "GA",
     "description": "Run tests as part of your pipeline",
-    "url": "/docs/pipeline-stages/testers"
+    "url": "/docs/pipeline-stages/testers",
+    "examples": [
+      {
+        "name": "custom test",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/custom-tests"
+      },
+      {
+        "name": "structure test",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/structure-tests"
+      }
+    ]
   },
   "test.structure": {
     "dev": "x",
@@ -370,7 +508,13 @@
     "area": "Test",
     "maturity": "GA",
     "description": "Run structure tests as part of your pipeline",
-    "url": "/docs/pipeline-stages/testers/structure"
+    "url": "/docs/pipeline-stages/testers/structure",
+    "examples": [
+      {
+        "name": "structure test",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/structure-tests"
+      }
+    ]
   },
   "test.custom": {
     "dev": "x",
@@ -380,7 +524,13 @@
     "feature": "custom tester",
     "maturity": "alpha",
     "description": "Run custom test command locally",
-    "url": "/docs/pipeline-stages/testers/custom"
+    "url": "/docs/pipeline-stages/testers/custom",
+    "examples": [
+      {
+        "name": "custom test",
+        "url": "https://github.com/GoogleContainerTools/skaffold/tree/main/examples/custom-tests"
+      }
+    ]
   },
   "triggers": {
     "dev": "x",

docs/layouts/partials/info-panel.html

@@ -9,6 +9,7 @@
 {{ $deploy := $data.deploy }}
 {{ $render := $data.render }}
 {{ $all := and $dev $debug $run $build $deploy $render }}
+{{ $examples := $data.examples }}
 
 <div class="alert infopanel" role="contentinfo">
     <table>
@@ -45,6 +46,17 @@
             </td>
         </tr>
         {{end}}
+
+        {{ if $examples}}
+        <tr>
+            <td><b>Code Samples</b></td>
+            <td>
+                {{ range $example := $examples }}
+                <a href="{{$example.url}}"><code>{{$example.name}}</code></a>
+                {{ end }}
+            </td>
+        </tr>
+        {{ end }}
     </table>
 </div>