GoogleContainerTools / GoogleContainerTools/skaffold

Currently skipping phases in `skaffold dev` in non-trivial and docs do not state such (imply the opposite)

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

Description

Currently the statement on https://skaffold.dev/docs/#skaffold-workflow-and-architecture - "Note: Any of these stages can be skipped" is actually true is misleading as it is non-trivial to disable certain phases/sub-phases in Skaffold. There is not actually any documentation on `skaffold.dev` about how to skip anything but the test stage. For example, to skip the build stage when running `skaffold dev` - a skaffold config needs to have a special ("don't build") profile in activeProfiles and have that toggled on (`-p dont-build`) so that the main project's dependencies aren't rebuilt from scratch.

- [ ] As a first step we should document these non-trivial patterns (dont-do-x profiles) on `skaffold.dev`
- [ ] As a second step we should add some flag values (similar to `--skip-tests`) to more phases and subphases

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.