GoogleContainerTools/skaffold

Document skaffold command init behavior

Open

#7,554 opened on Jun 15, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
bugbash/q4-2022help wantedkind/todo

Description

Background

  • #7515 changed init cmd behavior to generate skaffold.yaml fits v3alphal1 schema
  • If kustomize, raw manifests detected or cli provide manifests, generated skaffold config will have render config without deploy config
  • If helm charts are detected, generated skaffold ocnfig will have deploy config for helm without render config
  • We wants to document these behaviors on skaffold.dev

Related Future work

  • may add flags to customize these behaviors (needs discussions)

Contributor guide

Tech stack
gokubernetes
Domain
documentation
Issue type
documentation
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
Familiarity with skaffold initUnderstanding of skaffold config schemas
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review PR #7515 to understand the schema changes to v3alpha1. Examine the skaffold.dev documentation source for init command behavior. Propose specific documentation changes to reflect the new behavior for manifest detection and helm charts.
Document skaffold command init behavior · GoogleContainerTools/skaffold#7554 | Good First Issue