Empty, non-nil sync = sync all the files and infer destination

Signed-off-by: David Gageot <david@gageot.net>
GoogleContainerTools · Jan 10, 2020 · 68043c3 · 68043c3
1 parent 391dfa7
commit 68043c3
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 26 deletions.
diff --git a/docs/content/en/schemas/v2alpha2.json b/docs/content/en/schemas/v2alpha2.json
@@ -66,8 +66,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -100,8 +101,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -135,8 +137,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -170,8 +173,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -205,8 +209,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -240,8 +245,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -275,8 +281,9 @@
             },
             "sync": {
               "$ref": "#/definitions/Sync",
-              "description": "*beta* local files synced to pods instead of triggering an image build when modified.",
-              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified."
+              "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "x-intellij-html-description": "<em>beta</em> local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.",
+              "default": "infer: [\"**/*\"]"
             }
           },
           "preferredOrder": [
@@ -1964,8 +1971,9 @@
         "infer"
       ],
       "additionalProperties": false,
-      "description": "*beta* specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files.",
-      "x-intellij-html-description": "<em>beta</em> specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files."
+      "description": "*beta* specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files. If no files are listed, sync all the files and infer the destination.",
+      "x-intellij-html-description": "<em>beta</em> specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files. If no files are listed, sync all the files and infer the destination.",
+      "default": "infer: [\"**/*\"]"
     },
     "SyncRule": {
       "required": [

diff --git a/integration/examples/hot-reload/skaffold.yaml b/integration/examples/hot-reload/skaffold.yaml
@@ -4,15 +4,7 @@ build:
   artifacts:
   - image: gcr.io/k8s-skaffold/node-example
     context: node
-    sync:
-      manual:
-      - src: 'src/**/*.js'
-        dest: .
-        strip: src/
+    sync: {}
   - image: gcr.io/k8s-skaffold/python-reload
     context: python
-    sync:
-      manual:
-      - src: 'src/**/*.py'
-        dest: .
-        strip: src/
+    sync: {}
diff --git a/pkg/skaffold/schema/defaults/defaults.go b/pkg/skaffold/schema/defaults/defaults.go
@@ -38,6 +38,7 @@ func Set(c *latest.SkaffoldConfig) error {
 
 	for _, a := range c.Build.Artifacts {
 		setDefaultWorkspace(a)
+		setAutoSync(a)
 
 		if c.Build.Cluster != nil && a.CustomArtifact == nil {
 			defaultToKanikoArtifact(a)
@@ -200,6 +201,12 @@ func setDefaultWorkspace(a *latest.Artifact) {
 	a.Workspace = valueOrDefault(a.Workspace, ".")
 }
 
+func setAutoSync(a *latest.Artifact) {
+	if a.Sync != nil && len(a.Sync.Manual) == 0 && len(a.Sync.Infer) == 0 {
+		a.Sync.Infer = []string{"**/*"}
+	}
+}
+
 func withClusterConfig(c *latest.SkaffoldConfig, opts ...func(*latest.ClusterDetails) error) error {
 	clusterDetails := c.Build.BuildType.Cluster
 	if clusterDetails == nil {

diff --git a/pkg/skaffold/schema/defaults/defaults_test.go b/pkg/skaffold/schema/defaults/defaults_test.go
@@ -56,6 +56,7 @@ func TestSetDefaults(t *testing.T) {
 						ArtifactType: latest.ArtifactType{
 							BuildpackArtifact: &latest.BuildpackArtifact{},
 						},
+						Sync: &latest.Sync{},
 					},
 				},
 			},
@@ -81,6 +82,7 @@ func TestSetDefaults(t *testing.T) {
 	testutil.CheckDeepEqual(t, "fourth", cfg.Build.Artifacts[3].ImageName)
 	testutil.CheckDeepEqual(t, []string{"."}, cfg.Build.Artifacts[3].BuildpackArtifact.Dependencies.Paths)
 	testutil.CheckDeepEqual(t, []string(nil), cfg.Build.Artifacts[3].BuildpackArtifact.Dependencies.Ignore)
+	testutil.CheckDeepEqual(t, []string{"**/*"}, cfg.Build.Artifacts[3].Sync.Infer)
 }
 
 func TestSetDefaultsOnCluster(t *testing.T) {

diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -554,6 +554,8 @@ type Artifact struct {
 
 	// Sync *beta* lists local files synced to pods instead
 	// of triggering an image build when modified.
+	// If no files are listed, sync all the files and infer the destination.
+	// Defaults to `infer: ["**/*"]`
 	Sync *Sync `yaml:"sync,omitempty"`
 
 	// ArtifactType describes how to build an artifact.
@@ -562,6 +564,8 @@ type Artifact struct {
 
 // Sync *beta* specifies what files to sync into the container.
 // This is a list of sync rules indicating the intent to sync for source files.
+// If no files are listed, sync all the files and infer the destination.
+// Defaults to `infer: ["**/*"]`
 type Sync struct {
 	// Manual lists manual sync rules indicating the source and destination.
 	Manual []*SyncRule `yaml:"manual,omitempty" yamltags:"oneOf=sync"`