Merge pull request #2874 from tejal29/release_candidate

Changelog and update examples for releasing v0.38.0

CHANGELOG.md

@@ -1,3 +1,79 @@
+# v0.38.0 Release - 09/12/2019
+
+*Note*: This release comes with a new config version `v1beta14`.
+        To upgrade your `skaffold.yaml`, use `skaffold fix`. If you don't upgrade, skaffold will auto-upgrade in memory as best it can, and print a warning message.
+        See [deprecation-policy.md](/deprecation-policy.md) for details on what beta means.
+
+New Features:
+
+* Add Go container debugging support [#2306](https://github.com/GoogleContainerTools/skaffold/pull/2306)
+* Note: `jibMaven` and `jibGradle` are now just simply `jib` - your old config should be upgraded automatically. [#2808](https://github.com/GoogleContainerTools/skaffold/pull/2808)
+* Add Kaniko builder to GCB [#2708](https://github.com/GoogleContainerTools/skaffold/pull/2708)
+
+Bug Fixes:
+
+* Upgrade golangci-lint to v1.18.0 [#2853](https://github.com/GoogleContainerTools/skaffold/pull/2853)
+* Always add image flag to jib builders in skaffold init [#2854](https://github.com/GoogleContainerTools/skaffold/pull/2854)
+* add deploy stabilize timer [#2845](https://github.com/GoogleContainerTools/skaffold/pull/2845)
+* Only activate `env: "KEY="` for empty environment variable value, clearly document pattern behavior [#2839](https://github.com/GoogleContainerTools/skaffold/pull/2839)
+* Small random fixes to tests and code [#2801](https://github.com/GoogleContainerTools/skaffold/pull/2801)
+* skaffold init can be interrupted when kompose is running [#2803](https://github.com/GoogleContainerTools/skaffold/pull/2803)
+* Fix portforward flake [#2824](https://github.com/GoogleContainerTools/skaffold/pull/2824)
+* Improve `skaffold init` behaviour when tags are used in manifests [#2773](https://github.com/GoogleContainerTools/skaffold/pull/2773)
+* Skip secret creation/check [#2783](https://github.com/GoogleContainerTools/skaffold/pull/2783)
+
+Updates & Refactors:
+
+* Print deployment status check summary when a status check is completed. [#2811](https://github.com/GoogleContainerTools/skaffold/pull/2811)
+* add tests for `Status.String` method. [#2861](https://github.com/GoogleContainerTools/skaffold/pull/2861)
+* Update dependencies [#2857](https://github.com/GoogleContainerTools/skaffold/pull/2857)
+* Prepare to Add functionality to Replacer interface to restrict setting labels on certain kinds. [#2060](https://github.com/GoogleContainerTools/skaffold/pull/2060)
+* Add Resource.Status object and remove sync.Map [#2851](https://github.com/GoogleContainerTools/skaffold/pull/2851)
+* Add `Deployment` resource struct. [#2847](https://github.com/GoogleContainerTools/skaffold/pull/2847)
+* refactor pollDeploymentRolloutStatus [#2846](https://github.com/GoogleContainerTools/skaffold/pull/2846)
+* Improve runner [#2828](https://github.com/GoogleContainerTools/skaffold/pull/2828)
+* Ignore codecov.io upload errors [#2841](https://github.com/GoogleContainerTools/skaffold/pull/2841)
+* fix flake in in-cluster build [#2799](https://github.com/GoogleContainerTools/skaffold/pull/2799)
+* skaffold trace -> kaniko debug [#2823](https://github.com/GoogleContainerTools/skaffold/pull/2823)
+* Single way of mocking Kubernetes client/dynamic client [#2796](https://github.com/GoogleContainerTools/skaffold/pull/2796)
+* Remove caching flags true from integration test [#2831](https://github.com/GoogleContainerTools/skaffold/pull/2831)
+* add example for skaffold generate-pipeline [#2822](https://github.com/GoogleContainerTools/skaffold/pull/2822)
+* Improve versioning [#2798](https://github.com/GoogleContainerTools/skaffold/pull/2798)
+* Simplify TestBuildInCluster [#2829](https://github.com/GoogleContainerTools/skaffold/pull/2829)
+* Simplify doDev() [#2815](https://github.com/GoogleContainerTools/skaffold/pull/2815)
+* Remove misleading log [#2802](https://github.com/GoogleContainerTools/skaffold/pull/2802)
+* Merge back release/v0.37.1 [#2800](https://github.com/GoogleContainerTools/skaffold/pull/2800)
+* increasing unit test timeout to 90s [#2805](https://github.com/GoogleContainerTools/skaffold/pull/2805)
+* remove unused values helm example [#2819](https://github.com/GoogleContainerTools/skaffold/pull/2819)
+* Add --config-files flag for generate-pipeline command [#2766](https://github.com/GoogleContainerTools/skaffold/pull/2766)
+* Update dependencies [#2818](https://github.com/GoogleContainerTools/skaffold/pull/2818)
+
+Docs:
+
+* [doc-style]/Sorting out the tools list follow the workflow picture. [#2838](https://github.com/GoogleContainerTools/skaffold/pull/2838)
+* Design proposal for integrationtest command [#2671](https://github.com/GoogleContainerTools/skaffold/pull/2671)
+* Split the concepts section into several sub-pages [#2810](https://github.com/GoogleContainerTools/skaffold/pull/2810)
+
+Huge thanks goes out to all of our contributors for this release:
+
+- Aisuko
+- Andreas Sommer
+- Balint Pato
+- balopat
+- Brian de Alwis
+- Cedric Kring
+- Chanseok Oh
+- Cornelius Weig
+- daddz
+- David Gageot
+- Jack Davis
+- Marlon Gamez
+- Medya Gh
+- Nick Kubala
+- Prashant Arya
+- Tad Cordle
+- Tejal Desai
+
 # v0.37.1 Release - 09/04/2019
 
 This is a minor release for a privacy policy update:

examples/bazel/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/generate-pipeline/skaffold.yaml

@@ -6,4 +6,4 @@ build:
 deploy:
   kubectl:
     manifests:
-      - k8s-*
+    - k8s-*

examples/getting-started/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/google-cloud-build/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   googleCloudBuild:

examples/helm-deployment-dependencies/skaffold-helm/values.yaml

@@ -1,14 +1,42 @@
+# Default values for skaffold-helm.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
 replicaCount: 1
 image: nginx:stable
+# This is the helm convention on declaring images
+# image:
+#   repository: nginx
+#   tag: stable
+#   pullPolicy: IfNotPresent
 service:
   name: nginx
   type: ClusterIP
   externalPort: 80
   internalPort: 80
 ingress:
   enabled: false
+  # Used to create an Ingress record.
   hosts:
     - chart-example.local
+  annotations:
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  tls:
+    # Secrets must be manually created in the namespace.
+    # - secretName: chart-example-tls
+    #   hosts:
+    #     - chart-example.local
 resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #  cpu: 100m
+  #  memory: 128Mi
+  # requests:
+  #  cpu: 100m
+  #  memory: 128Mi
+
 subchart:
-  enabled: true
+    enabled: true    

examples/helm-deployment-dependencies/skaffold.yaml

@@ -1,16 +1,28 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   tagPolicy:
     sha256: {}
   artifacts:
-    - image: gcr.io/k8s-skaffold/skaffold-helm
+  - image: gcr.io/k8s-skaffold/skaffold-helm
 deploy:
   helm:
     releases:
-      - name: skaffold-helm
-        chartPath: skaffold-helm
-        skipBuildDependencies: true
-        values:
-          image: gcr.io/k8s-skaffold/skaffold-helm
-          "skaffold-helm-subchart.image": gcr.io/k8s-skaffold/skaffold-helm
+    - name: skaffold-helm
+      chartPath: skaffold-helm
+      #wait: true
+      #valuesFiles:
+      #- helm-skaffold-values.yaml
+      skipBuildDependencies: true # Skip helm dep build
+      values:
+        image: gcr.io/k8s-skaffold/skaffold-helm
+        "skaffold-helm-subchart.image": gcr.io/k8s-skaffold/skaffold-helm
+      #recreatePods will pass --recreate-pods to helm upgrade
+      #recreatePods: true
+      #overrides builds an override values.yaml file to run with the helm deploy
+      #overrides:
+      # some:
+      #   key: someValue
+      #setValues get appended to the helm deploy with --set.  
+      #setValues:
+        #some.key: someValue

examples/helm-deployment/skaffold-helm/values.yaml

@@ -1,9 +1,38 @@
+# Default values for skaffold-helm.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
 replicaCount: 1
+# This is the helm convention on declaring images
+# image:
+#   repository: nginx
+#   tag: stable
+#   pullPolicy: IfNotPresent
 service:
   name: nginx
   type: NodePort
   externalPort: 80
   internalPort: 80
 ingress:
   enabled: true
+  # Used to create an Ingress record.
+  hosts:
+    # - chart-example.local
+  annotations:
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  tls:
+    # Secrets must be manually created in the namespace.
+    # - secretName: chart-example-tls
+    #   hosts:
+    #     - chart-example.local
 resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #  cpu: 100m
+  #  memory: 128Mi
+  # requests:
+  #  cpu: 100m
+  #  memory: 128Mi

examples/helm-deployment/skaffold.yaml

@@ -1,17 +1,26 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   tagPolicy:
     sha256: {}
   artifacts:
-    - image: gcr.io/k8s-skaffold/skaffold-helm
-      sync:
-        infer:
-          - "static/**.html"
+  - image: gcr.io/k8s-skaffold/skaffold-helm
 deploy:
   helm:
     releases:
-      - name: skaffold-helm
-        chartPath: skaffold-helm
-        values:
-          image: gcr.io/k8s-skaffold/skaffold-helm
+    - name: skaffold-helm
+      chartPath: skaffold-helm
+      #wait: true
+      #valuesFiles:
+      #- helm-skaffold-values.yaml
+      values:
+        image: gcr.io/k8s-skaffold/skaffold-helm
+      #recreatePods will pass --recreate-pods to helm upgrade
+      #recreatePods: true
+      #overrides builds an override values.yaml file to run with the helm deploy
+      #overrides:
+      # some:
+      #   key: someValue
+      #setValues get appended to the helm deploy with --set.
+      #setValues:
+        #some.key: someValue

examples/hot-reload/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/jib-gradle/skaffold.yaml

@@ -1,9 +1,9 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:
   - image: gcr.io/k8s-skaffold/skaffold-jib-gradle
-    jibGradle: {}
+    jib: {}
 
 # optional profile to run the jib build on Google Cloud Build
 profiles:

examples/jib-multimodule/README.adoc

@@ -2,10 +2,10 @@
 :icons: font
 
 Jib is one of the supported builders in Skaffold.
-[Jib](https://github.com/GoogleContainerTools/jib) builds Docker and OCI images
+https://github.com/GoogleContainerTools/jib[Jib] builds Docker and OCI images
 for your Java applications and is available as plugins for Maven and Gradle.
 
-Sometimes a project is configured to have multiple modules to create several
+Sometimes a project is configured to have multiple _modules_ to create several
 container images.  Skaffold can work with Jib to build these containers as
 required.
 
@@ -18,14 +18,17 @@ build:
      - image: gcr.io/k8s-skaffold/skaffold-jib-1
        # context is the root of the multi-module project
        context: .
-       jibMaven:
-          # module is either the relative location within the project (i.e.,
-          # relative to `context`) or :artifactId or groupId:artifactId
-          module: moduleLocation
+       jib:
+          # project is the location relative to the artifact `context`
+          # For Maven, this is either the path relative to the artifact's
+          # `context`, or `:artifactId` or `groupId:artifactId`.
+          # For Gradle, this is the project name (defaults to the
+          # directory name).
+          project: moduleLocation
      - image: gcr.io/k8s-skaffold/skaffold-jib-2
        context: .
-       jibMaven:
-          module: :artifactId
+       jib:
+          project: :artifactId
 ----
 
 There are a few caveats:

examples/jib-multimodule/skaffold.yaml

@@ -1,15 +1,15 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:
   - image: gcr.io/k8s-skaffold/skaffold-jib-1
-    jibMaven:
-      # module can be the relative directory
-      module: project1
+    jib:
+      # project can be the relative directory
+      project: project1
   - image: gcr.io/k8s-skaffold/skaffold-jib-2
-    jibMaven:
-      # module can be [groupId]:artifactId
-      module: :skaffold-project-2
+    jib:
+      # project can be [groupId]:artifactId
+      project: :skaffold-project-2
 
 # optional profile to run the jib build on Google Cloud Build
 profiles:

examples/jib/README.adoc

@@ -13,7 +13,7 @@ build:
      artifacts:
      - image: gcr.io/k8s-skaffold/skaffold-example
        context: .
-       jibMaven: {}
+       jib: {}
 ----
 
 Please note that this example is for a standalone Maven project, where

examples/jib/skaffold.yaml

@@ -1,9 +1,9 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:
   - image: gcr.io/k8s-skaffold/skaffold-jib
-    jibMaven: {}
+    jib: {}
 
 # optional profile to run the jib build on Google Cloud Build
 profiles:

examples/kaniko-local/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/kaniko/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/kustomize/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 deploy:
   kustomize: {}

examples/microservices/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/nodejs/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts:

examples/react-reload/skaffold.yaml

@@ -1,4 +1,4 @@
-apiVersion: skaffold/v1beta13
+apiVersion: skaffold/v1beta14
 kind: Config
 build:
   artifacts: