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.

Sign up for GitHub

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

Jump to bottom

Document how to disable autosync for buildpacks #4805

Merged
merged 3 commits into from
Sep 23, 2020
Merged

Document how to disable autosync for buildpacks #4805

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5703eda
document how to disable buildpacks auto-sync
briandealwis Sep 18, 2020
d7f8a4f
revise
briandealwis Sep 18, 2020
c66f37d
revert mistaken skaffold.yaml change
briandealwis Sep 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions docs/content/en/docs/pipeline-stages/filesync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,45 @@ File deletion will always cause a complete rebuild.

### Auto sync mode

In auto sync mode, Skaffold automatically generates sync rules for known file types. Changes to other file types will
result in a complete rebuild.
In auto sync mode, Skaffold automatically generates sync rules for known file types.
Changes to other file types will result in a complete rebuild.

#### Buildpacks

Skaffold requires special collaboration from the Buildpacks for the `auto` sync to work.
The [gcr.io/buildpacks/builder:v1](https://github.com/GoogleCloudPlatform/buildpacks) supports Skaffold
out of the box, currently for Go, NodeJS, and Java.
Skaffold works with Cloud Native Buildpacks builders to automatically sync and relaunch
applications on changes to certain types of files.
The GCP Buildpacks builder ([gcr.io/buildpacks/builder:v1](https://github.com/GoogleCloudPlatform/buildpacks))
supports syncing the following types of source files:

- Go: *.go
- Java: *.java, *.kt, *.scala, *.groovy, *.clj
- NodeJS: *.js, *.mjs, *.coffee, *.litcoffee, *.json

The GCP Buildpacks builder will detect the changed files and
automatically rebuild and relaunch the application.
Changes to other file types trigger an image rebuild.

##### Disable Auto Sync for Buildpacks

To disable auto sync, simply provide a manual sync rule. It does
not matter if the sync rule does not match any actual files.
For example:

```
artifacts:
- image: xxx
buildpacks:
builder: gcr.io/buildpacks/builder:v1
# disable buildpacks auto-sync
sync:
manual:
- src: .
dest: .
```

##### How it works

Skaffold requires special collaboration from buildpacks for the `auto` sync to work.

Cloud Native Buildpacks set a `io.buildpacks.build.metadata` label on the images they create.
This labels points to json description of the [Bill-of-Materials, aka BOM](https://github.com/buildpacks/spec/blob/master/buildpack.md#bill-of-materials-toml) of the build.
Expand Down