Skip to content

Commit

Permalink
chore: add docs to explain keep-running-on-failure (#8446)
Browse files Browse the repository at this point in the history
* chore: add docs to explain keep-running-on-failure

* Update docs-v2/content/en/docs/workflows/dev.md

Co-authored-by: Aaron Prindle <aprindle@google.com>

---------

Co-authored-by: Aaron Prindle <aprindle@google.com>
  • Loading branch information
ericzzzzzzz and aaron-prindle authored Feb 23, 2023
1 parent f0a4ed7 commit db10698
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs-v2/content/en/docs/workflows/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Running `skaffold dev` is equivalent to running the IDE command `Run on Kubernet

## Dev loop

When `skaffold dev` is run, Skaffold will first do a full build, test and deploy of all artifacts specified in the `skaffold.yaml`, similar to `skaffold run`. Upon successful build, test and deploy, Skaffold will start watching all source file dependencies for all artifacts specified in the project. As changes are made to these source files, Skaffold will rebuild and retest the associated artifacts, and redeploy the new changes to your cluster.
When `skaffold dev` is run, Skaffold will first do a full build, test, render and deploy of all artifacts specified in the `skaffold.yaml`, similar to `skaffold run`. By default, Skaffold will exit if any of these stages fails. Upon successful build, test, render and deploy, Skaffold will start watching all source file dependencies for all artifacts specified in the project. As changes are made to these source files, Skaffold will rebuild and retest the associated artifacts, and redeploy the new changes to your cluster.

The ``--keep-running-on-failure`` flag can be used to keep Skaffold running by suspending the Skaffold session while encountering errors in the first build, test, render, deploy. The user can attempt to fix the errors and then restore the session by pressing any key or exit the session with ``Ctrl+C``. The session will be suspended again unless the errors are fixed. Using this flag should result in an better experience for `dev` sessions where errors occur that would otherwise cause Skaffold to exit

The dev loop will run until the user cancels the Skaffold process with `Ctrl+C`. Upon receiving this signal, Skaffold will clean up all deployed artifacts on the active cluster, meaning that Skaffold won't abandon any Kubernetes resources that it created throughout the lifecycle of the run. This can be optionally disabled by using the `--no-prune` flag.

Expand Down

0 comments on commit db10698

Please sign in to comment.