GoogleContainerTools / GoogleContainerTools/skaffold

"Deploy Status Checking" doc implies iterative-status-check is default-off and requires opt-in.

Open
#8,731 1 comment 0 reactions 0 assignees View on GitHub
area/docs kind/friction priority/p2
Dominant language
Go
Stars
15.9k
Forks
1.7k
Avg merge
3d 9h
Merged PRs (30d)
10

Description

The ["Configuring status-check for multiple deployers or multiple modules"](https://skaffold.dev/docs/status-check/#configuring-status-check-for-multiple-deployers-or-multiple-modules) section describes status checking behaviours and defaults:

> Single status check after all deployers are run. This is the default...
> [...]
> Per-deployer status check. This can be enabled by using the --iterative-status-check=true flag.

But it seems the default value for `--iterative-status-check` is already true from its [definition](https://github.com/GoogleContainerTools/skaffold/blob/9bb2c5d66858e1fb4ef55b3b948f2e82dc74ee0f/cmd/skaffold/app/cmd/flags.go#L330); if I've understood correctly, it is the single status-check behaviour that must be opted into by setting `--iterative-status-check=false`.

Is the doc incorrect and in need of a fix?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.