GoogleContainerTools/skaffold

Add --cache-file flag to `render` command

Open

#6,805 opened on Nov 5, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/ci-cdbugbash/q4-2022help wantedkind/feature-requestpriority/p3

Description

I'm using skaffold render in my CI/CD GitOps pipeline, and would like to reuse Skaffold cache file between runs, to avoid the dreaded Checking cache... Not found. Building. However, I need to write this cache file to a specific location that's not $HOME/.skaffold/cache, because that directory is not preserved between my CI steps.

I could move the directory explicitly before/after running skaffold render, but it's pretty inconvenient. Other commands (build, dev etc.) expose --cache-file flag to specify its location, and I'd like it to be added to render as well, if possible.

Alternatively, if there's any way to set the "Skaffold directory" (from the default $HOME/.skaffold), that could work too (and maybe even better!)

Expected behavior

skaffold render has --cache-file flag

Actual behavior

--cache-file flag is not available for skaffold render

Information

  • Skaffold version: v1.34.0
  • Operating system: Ubuntu 20.10
  • Installed via: Cloud Code
  • Contents of skaffold.yaml: N/A

Steps to reproduce the behavior

  1. Run skaffold render --cache-file=.skaffold/cache
  2. Observe the result:
unknown flag: --cache-file
See 'skaffold render --help' for usage.

Contributor guide

Tech stack
gokubernetes
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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 GoUnderstanding of Skaffold CLI commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at how the cache file flag is implemented in the build and dev commands (e.g., in cmd/skaffold/app/cmd/build.go and cmd/skaffold/app/cmd/dev.go). Then add the same flag to the render command in cmd/skaffold/app/cmd/render.go. Ensure the flag is passed to the cache initialization function, likely in pkg/skaffold/cache/. Check the test files for examples of how to add tests for the new flag.