feat(container): add build.targetImage parameter

Allows referencing a specific image in a multi-stage Dockerfile. Needed a refactor to be able to add a field to the build schema.
garden-io · Feb 27, 2019 · 9bf6aa1 · 9bf6aa1
1 parent ee9165a
commit 9bf6aa1
Show file tree

Hide file tree

Showing 16 changed files with 455 additions and 75 deletions.
diff --git a/docs/reference/config.md b/docs/reference/config.md
@@ -313,26 +313,6 @@ Specify how to build the module. Note that plugins may define additional keys on
 | Type | Required |
 | ---- | -------- |
 | `object` | No
-### `module.build.command[]`
-[module](#module) > [build](#module.build) > command
-
-The command to run inside the module's directory to perform the build.
-
-| Type | Required |
-| ---- | -------- |
-| `array[string]` | No
-
-Example:
-```yaml
-module:
-  ...
-  build:
-    ...
-    command:
-      - npm
-      - run
-      - build
-```
 ### `module.build.dependencies[]`
 [module](#module) > [build](#module.build) > dependencies
 
@@ -395,8 +375,6 @@ module:
   repositoryUrl:
   allowPublish: true
   build:
-    command:
-      []
     dependencies:
       - name:
         copy:

diff --git a/docs/reference/module-types/container.md b/docs/reference/module-types/container.md
@@ -13,6 +13,72 @@ Configuration for a container module.
 | Type | Required |
 | ---- | -------- |
 | `object` | No
+### `module.build`
+[module](#module) > build
+
+Specify how to build the module. Note that plugins may define additional keys on this object.
+
+| Type | Required |
+| ---- | -------- |
+| `object` | No
+### `module.build.dependencies[]`
+[module](#module) > [build](#module.build) > dependencies
+
+A list of modules that must be built before this module is built.
+
+| Type | Required |
+| ---- | -------- |
+| `array[object]` | No
+
+Example:
+```yaml
+module:
+  ...
+  build:
+    ...
+    dependencies:
+      - name: some-other-module-name
+```
+### `module.build.dependencies[].name`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > name
+
+Module name to build ahead of this module.
+
+| Type | Required |
+| ---- | -------- |
+| `string` | Yes
+### `module.build.dependencies[].copy[]`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > copy
+
+Specify one or more files or directories to copy from the built dependency to this module.
+
+| Type | Required |
+| ---- | -------- |
+| `array[object]` | No
+### `module.build.dependencies[].copy[].source`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > [copy](#module.build.dependencies[].copy[]) > source
+
+POSIX-style path or filename of the directory or file(s) to copy to the target.
+
+| Type | Required |
+| ---- | -------- |
+| `string` | Yes
+### `module.build.dependencies[].copy[].target`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > [copy](#module.build.dependencies[].copy[]) > target
+
+POSIX-style path or filename to copy the directory or file(s) to (defaults to same as source path).
+
+| Type | Required |
+| ---- | -------- |
+| `string` | No
+### `module.build.targetImage`
+[module](#module) > [build](#module.build) > targetImage
+
+For multi-stage Dockerfiles, specify which image to build (see https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target for details).
+
+| Type | Required |
+| ---- | -------- |
+| `string` | No
 ### `module.buildArgs`
 [module](#module) > buildArgs
 
@@ -491,6 +557,13 @@ module:
 ## Complete YAML schema
 ```yaml
 module:
+  build:
+    dependencies:
+      - name:
+        copy:
+          - source:
+            target: ''
+    targetImage:
   buildArgs: {}
   image:
   hotReload:

diff --git a/docs/reference/module-types/exec.md b/docs/reference/module-types/exec.md
@@ -13,6 +13,84 @@ The module specification for an exec module.
 | Type | Required |
 | ---- | -------- |
 | `object` | No
+### `module.build`
+[module](#module) > build
+
+Specify how to build the module. Note that plugins may define additional keys on this object.
+
+| Type | Required |
+| ---- | -------- |
+| `object` | No
+### `module.build.dependencies[]`
+[module](#module) > [build](#module.build) > dependencies
+
+A list of modules that must be built before this module is built.
+
+| Type | Required |
+| ---- | -------- |
+| `array[object]` | No
+
+Example:
+```yaml
+module:
+  ...
+  build:
+    ...
+    dependencies:
+      - name: some-other-module-name
+```
+### `module.build.dependencies[].name`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > name
+
+Module name to build ahead of this module.
+
+| Type | Required |
+| ---- | -------- |
+| `string` | Yes
+### `module.build.dependencies[].copy[]`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > copy
+
+Specify one or more files or directories to copy from the built dependency to this module.
+
+| Type | Required |
+| ---- | -------- |
+| `array[object]` | No
+### `module.build.dependencies[].copy[].source`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > [copy](#module.build.dependencies[].copy[]) > source
+
+POSIX-style path or filename of the directory or file(s) to copy to the target.
+
+| Type | Required |
+| ---- | -------- |
+| `string` | Yes
+### `module.build.dependencies[].copy[].target`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > [copy](#module.build.dependencies[].copy[]) > target
+
+POSIX-style path or filename to copy the directory or file(s) to (defaults to same as source path).
+
+| Type | Required |
+| ---- | -------- |
+| `string` | No
+### `module.build.command[]`
+[module](#module) > [build](#module.build) > command
+
+The command to run inside the module's directory to perform the build.
+
+| Type | Required |
+| ---- | -------- |
+| `array[string]` | No
+
+Example:
+```yaml
+module:
+  ...
+  build:
+    ...
+    command:
+      - npm
+      - run
+      - build
+```
 ### `module.env`
 [module](#module) > env
 
@@ -122,6 +200,14 @@ Key/value map of environment variables. Keys must be valid POSIX environment var
 ## Complete YAML schema
 ```yaml
 module:
+  build:
+    dependencies:
+      - name:
+        copy:
+          - source:
+            target: ''
+    command:
+      []
   env: {}
   tasks:
     - name:

diff --git a/docs/reference/module-types/helm.md b/docs/reference/module-types/helm.md
@@ -30,6 +30,64 @@ module:
   ...
   base: "my-base-chart"
 ```
+### `module.build`
+[module](#module) > build
+
+Specify how to build the module. Note that plugins may define additional keys on this object.
+
+| Type | Required |
+| ---- | -------- |
+| `object` | No
+### `module.build.dependencies[]`
+[module](#module) > [build](#module.build) > dependencies
+
+A list of modules that must be built before this module is built.
+
+| Type | Required |
+| ---- | -------- |
+| `array[object]` | No
+
+Example:
+```yaml
+module:
+  ...
+  build:
+    ...
+    dependencies:
+      - name: some-other-module-name
+```
+### `module.build.dependencies[].name`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > name
+
+Module name to build ahead of this module.
+
+| Type | Required |
+| ---- | -------- |
+| `string` | Yes
+### `module.build.dependencies[].copy[]`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > copy
+
+Specify one or more files or directories to copy from the built dependency to this module.
+
+| Type | Required |
+| ---- | -------- |
+| `array[object]` | No
+### `module.build.dependencies[].copy[].source`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > [copy](#module.build.dependencies[].copy[]) > source
+
+POSIX-style path or filename of the directory or file(s) to copy to the target.
+
+| Type | Required |
+| ---- | -------- |
+| `string` | Yes
+### `module.build.dependencies[].copy[].target`
+[module](#module) > [build](#module.build) > [dependencies](#module.build.dependencies[]) > [copy](#module.build.dependencies[].copy[]) > target
+
+POSIX-style path or filename to copy the directory or file(s) to (defaults to same as source path).
+
+| Type | Required |
+| ---- | -------- |
+| `string` | No
 ### `module.chart`
 [module](#module) > chart
 
@@ -421,6 +479,12 @@ Map of values to pass to Helm when rendering the templates. May include arrays a
 ```yaml
 module:
   base:
+  build:
+    dependencies:
+      - name:
+        copy:
+          - source:
+            target: ''
   chart:
   chartPath: .
   dependencies: []