GoogleContainerTools/skaffold

Skaffold file output flags are inconsistent

Open

#3150 opened on Nov 1, 2019

View on GitHub
 (3 comments) (1 reaction) (1 assignee)Go (12,822 stars) (1,416 forks)batch import
area/cliarea/uxfixithelp wantedjuly-chillkind/feature-requestpriority/p2

Description

Skaffold supports writing a few different run results to files for use in other commands or k8s-related processes. However, these files all have different flag names, making it difficult to know which one to use for which command.

writing the built artifact results from skaffold build - --file-output consuming this generated file in skaffold deploy - --artifacts, or -a outputting templated manifests from skaffold render - --output, or -o

We should decide on a common flag name and just use that everywhere, or at least for build and render where the flag is actually specifying an output.

Contributor guide

Tech stack
go
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GoSkaffold CLIflag handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the current flag definitions for 'skaffold build', 'skaffold deploy', and 'skaffold render' in the cmd/skaffold/app/cmd directory. The issue highlights file output, artifacts, and output flags. Propose a unified flag name and implement changes across the affected commands. Also update any related documentation.