GoogleContainerTools/skaffold

k8s error formatting is hard to read

Open

#6,937 opened on Dec 5, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (1,416 forks)batch import
area/uxhelp wantedkind/usabilitypriority/p3

Repository metrics

Stars
 (12,822 stars)
PR merge metrics
 (Avg merge 3d 6h) (16 merged PRs in 30d)

Description

k8s returns this mass (newlines added so it looks more like it does in a terminal:

image

I wish something would, at minimum, do python-style indents at colons:

 - Error from server (BadRequest): error when creating "STDIN": 
     Deployment in version "v1" cannot be handled as a Deployment: 
       v1.Deployment.Spec: 
         v1.DeploymentSpec.Template: 
           v1.PodTemplateSpec.Spec: 
             v1.PodSpec.Containers: []v1.Container: 
               v1.Container.VolumeMounts: 
                 []v1.VolumeMount: 
                   Resources: 
                     v1.ResourceRequirements.Limits: 
                       unmarshalerDecoder: 
                         quantities must match the regular expression '^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$', 
                         error found in #10 byte of 
                         ...|":"300MiB"}},"volume|..., bigger context ...|"resources":{"limits":{"cpu":"1","memory":"300MiB"}},"volumeMounts":[{"mountPath":"/verdaccio/storag|...

Contributor guide

Research direction
Investigate how Kubernetes errors are currently formatted in skaffold. Trace the error path from API calls to output. Then modify the formatting to add indentation as suggested.
Tech stack
go
Domain
developer 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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGitKubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75