update docs

GoogleContainerTools · Feb 20, 2020 · 29f21b9 · 29f21b9
1 parent 3e13394
commit 29f21b9
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/jib-gradle-plugin/CHANGELOG.md b/jib-gradle-plugin/CHANGELOG.md
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 - Additionally reads credentials from `~/.docker/.dockerconfigjson` and legacy Docker config (`~/.docker/.dockercfg`). Also searches for `$HOME/.docker/*` (in addition to current `System.get("user.home")/.docker/*`). This may help retrieve credentials, for example, on Kubernetes. ([#2260](https://github.com/GoogleContainerTools/jib/issues/2260))
+- New skaffold configuration options that modify how jib's build config is presetned to skaffold ([#2292](https://github.com/GoogleContainerTools/jib/pull/2292)):
+    - `jib.skaffold.watch.buildIncludes`: a list of build files to watch
+    - `jib.skaffold.watch.includes`: a list of project files to watch
+    - `jib.skaffold.watch.excludes`: a list of files to ignore from watching
+    - `jib.skaffold.sync.excludes`: a list of files to exclude from sync'ing
 
 ### Changed
 

diff --git a/jib-gradle-plugin/README.md b/jib-gradle-plugin/README.md
@@ -34,6 +34,7 @@ For information about the project, see the [Jib project README](../README.md).
     * [Using Docker Credential Helpers](#using-docker-credential-helpers)
     * [Using Specific Credentials](#using-specific-credentials)
   * [WAR Projects](#war-projects)
+  * [Skaffold Integration](#skaffold-integration)
 * [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
 * [Community](#community)
 
@@ -452,6 +453,29 @@ jib {
 }
 ```
 
+### Skaffold Integration
+
+Jib is an included builder in [Skaffold](https://github.com/GoogleContainerTools/skaffold). Jib passes on build information to skaffold through special internal tasks so that skaffold understands when it should rebuild or synchronize files. For complex builds the defaults may not be sufficient, so the `jib` extension provides a `skaffold` configuration closure which exposes:
+
+Field | Type | Default | Description
+--- | --- | --- | ---
+`watch` | [`watch`](#skaffold-watch-closure) | *None* | Addition configuration for file watching
+`sync` | [`sync`](#skaffold-sync-closure) | *None* | Additional configuration for file synchronization
+
+<a name="skaffold-watch-closure"></a>`watch` is a closure with the following properties:
+
+Field | Type | Default | Description
+--- | --- | --- | ---
+`buildIncludes` | `List<String>` | *None* | Addition build files that skaffold should watch
+`includes` | `List<String>` | *None* | Additional project files or directories that skaffold should watch
+`excludes` | `List<String>` | *None* | Files and directories that skaffold should not watch
+
+<a name="skaffold-sync-closure"></a>`sync` is a closure with the following properties:
+
+Field | Type | Default | Description
+--- | --- | --- | ---
+`excludes` | `List<String>` | *None* | Files and directories that skaffold should not sync
+
 ## Frequently Asked Questions (FAQ)
 
 See the [Jib project FAQ](../docs/faq.md).

diff --git a/jib-maven-plugin/CHANGELOG.md b/jib-maven-plugin/CHANGELOG.md
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 - Additionally reads credentials from `~/.docker/.dockerconfigjson` and legacy Docker config (`~/.docker/.dockercfg`). Also searches for `$HOME/.docker/*` (in addition to current `System.get("user.home")/.docker/*`). This may help retrieve credentials, for example, on Kubernetes. ([#2260](https://github.com/GoogleContainerTools/jib/issues/2260))
+- New skaffold configuration options that modify how jib's build config is presetned to skaffold ([#2292](https://github.com/GoogleContainerTools/jib/pull/2292)):
+    - `<watch><buildIncludes>`: a list of build files to watch
+    - `<watch><includes>`: a list of project files to watch
+    - `<watch><excludes>`: a list of files to ignore from watching
+    - `<sync><excludes>`: a list of files to exclude from sync'ing
 
 ### Changed
 

diff --git a/jib-maven-plugin/README.md b/jib-maven-plugin/README.md
@@ -34,6 +34,7 @@ For information about the project, see the [Jib project README](../README.md).
     * [Using Docker Credential Helpers](#using-docker-credential-helpers)
     * [Using Specific Credentials](#using-specific-credentials)
   * [WAR Projects](#war-projects)
+  * [Skaffold Integration](#skaffold-integration)
 * [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
 * [Community](#community)
 
@@ -556,6 +557,29 @@ To use a different Servlet engine base image, you can customize `<container><app
 </configuration>
 ```
 
+### Skaffold Integration
+
+Jib is an included builder in [Skaffold](https://github.com/GoogleContainerTools/skaffold). Jib passes on build information to skaffold through special internal goals so that skaffold understands when it should rebuild or synchronize files. For complex builds, the defaults may not be sufficient, so the jib plugin provides a `skaffold` configuration object which exposes:
+
+Field | Type | Default | Description
+--- | --- | --- | ---
+`watch` | [`watch`](#skaffold-watch-object) | *None* | Addition configuration for file watching
+`sync` | [`sync`](#skaffold-sync-object) | *None* | Additional configuration for file synchronization
+
+<a name="skaffold-watch-object"></a>`watch` is an object with the following properties:
+
+Field | Type | Default | Description
+--- | --- | --- | ---
+`buildIncludes` | `List<String>` | *None* | Addition build files that skaffold should watch
+`includes` | `List<String>` | *None* | Additional project files or directories that skaffold should watch
+`excludes` | `List<String>` | *None* | Files and directories that skaffold should not watch
+
+<a name="skaffold-sync-object"></a>`sync` is an object with the following properties:
+
+Field | Type | Default | Description
+--- | --- | --- | ---
+`excludes` | `List<String>` | *None* | Files and directories that skaffold should not sync
+
 ## Frequently Asked Questions (FAQ)
 
 See the [Jib project FAQ](../docs/faq.md).