Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README for skaffold config #2304

Merged
merged 13 commits into from
Mar 4, 2020
24 changes: 24 additions & 0 deletions jib-gradle-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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:
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved

Field | Type | Default | Description
--- | --- | --- | ---
`watch` | [`watch`](#skaffold-watch-closure) | *None* | Addition configuration for file watching
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved
`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
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved
`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).
Expand Down
24 changes: 24 additions & 0 deletions jib-maven-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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:
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved

Field | Type | Default | Description
--- | --- | --- | ---
`watch` | [`watch`](#skaffold-watch-object) | *None* | Addition configuration for file watching
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved
`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
loosebazooka marked this conversation as resolved.
Show resolved Hide resolved
`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).
Expand Down