Skip to content

Commit

Permalink
docs: dev.md improvements (#6503)
Browse files Browse the repository at this point in the history
- added note about the API (relevant to <1% users)
- attempt to clarify what `notify` means by replacing it

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
  • Loading branch information
ahmetb committed Aug 25, 2021
1 parent 0fda1f5 commit d3839f4
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/content/en/docs/workflows/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,19 @@ The actions performed by Skaffold during the dev loop have precedence over one a

Skaffold computes the dependencies for each artifact based on the builder being used, and the root directory of the artifact. Once all source file dependencies are computed, in `dev` mode, Skaffold will continuously watch these files for changes in the background, and conditionally re-run the loop when changes are detected.

By default, Skaffold uses `notify` to monitor events on the local filesystem. Skaffold also supports a `polling` mode where the filesystem is checked for changes on a configurable interval, or a `manual` mode, where Skaffold waits for user input to check for file changes. These watch modes can be configured through the `--trigger` flag.
By default, Skaffold uses filesystem notifications of your OS to monitor changes
on the local filesystem and re-runs the loop on every change.

## Control API
Skaffold also supports a `polling` mode where the filesystem is checked for
changes on a configurable interval, or a `manual` mode, where Skaffold waits for
user input to check for file changes. These watch modes can be configured
through the `--trigger` flag.

## Controlling the Dev Loop with API

{{< alert title="Note">}}
This section is intended for developers who build tooling on top of Skaffold.
{{</alert>}}

By default, the dev loop will carry out all actions (as needed) each time a file is changed locally, with the exception of operating in `manual` trigger mode. However, individual actions can be gated off by user input through the Skaffold API.

Expand Down

0 comments on commit d3839f4

Please sign in to comment.