From fcab7599c63ceb4ac55d3c2992bcacfaae05a66f Mon Sep 17 00:00:00 2001 From: ericzzzzzzz <102683393+ericzzzzzzz@users.noreply.github.com> Date: Thu, 16 Feb 2023 11:32:14 -0500 Subject: [PATCH 1/2] chore: add docs to explain keep-running-on-failure --- docs-v2/content/en/docs/workflows/dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-v2/content/en/docs/workflows/dev.md b/docs-v2/content/en/docs/workflows/dev.md index aac94633e70..5bd696d3db1 100644 --- a/docs-v2/content/en/docs/workflows/dev.md +++ b/docs-v2/content/en/docs/workflows/dev.md @@ -19,7 +19,7 @@ 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. ``--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. 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 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. From 7b2e955f2b58315f9d1d12b908ef645f4476a93b Mon Sep 17 00:00:00 2001 From: ericzzzzzzz <102683393+ericzzzzzzz@users.noreply.github.com> Date: Thu, 23 Feb 2023 07:02:00 -0500 Subject: [PATCH 2/2] Update docs-v2/content/en/docs/workflows/dev.md Co-authored-by: Aaron Prindle --- docs-v2/content/en/docs/workflows/dev.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs-v2/content/en/docs/workflows/dev.md b/docs-v2/content/en/docs/workflows/dev.md index 5bd696d3db1..575c5758a37 100644 --- a/docs-v2/content/en/docs/workflows/dev.md +++ b/docs-v2/content/en/docs/workflows/dev.md @@ -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, 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. ``--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. 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. +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.