feat: add buildDependenciesSkipRefresh option to HelmRelease to pass --skip-refresh to helm dep bulid by art-shutter · Pull Request #9672 · GoogleContainerTools/skaffold

art-shutter · 2025-01-20T12:20:40Z

Description
This adds a new configuration option buildDependenciesSkipRefresh to skaffold render config.

User facing changes
Users can now supply a new option in the helm config for skaffold render when using helm as a renderer

google-cla · 2025-01-20T12:20:46Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

ghost

Hi team,

I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:

This pull request, authored by art-shutter, adds a new configuration option buildDependenciesSkipRefresh to the HelmRelease section of the Skaffold configuration. The goal is to allow users to skip refreshing already built Helm dependencies when using helm dep build. This addresses issue #8413.

Here's a breakdown of the changes:

Added buildDependenciesSkipRefresh option: A new boolean field, buildDependenciesSkipRefresh, has been added to the HelmRelease struct in pkg/skaffold/schema/latest/config.go (lines 1050-1055). This option defaults to false.
Updated schema: The schema definition in docs-v2/content/en/schemas/v4beta12.json has been updated to reflect the new option (lines 2365-2376 and 2494-2506).
Implemented skip refresh logic: The helm.go file (pkg/skaffold/render/renderer/helm/helm.go) now incorporates the buildDependenciesSkipRefresh option. If it's set to true, the --skip-refresh flag is passed to the helm dep build command (lines 208-218).
Minor cleanup: Some minor formatting changes were made in pkg/skaffold/schema/latest/config.go (lines 1856-1865 and 1883-1891).

The changes are well-structured and easy to follow. The addition of the buildDependenciesSkipRefresh option provides a valuable performance improvement for users with large Helm charts.

And now, a little haiku to lighten the mood:

Code flows like a stream,
New features gently emerge,
Reviews make it shine.

ghost

This pull request adds a buildDependenciesSkipRefresh option to the HelmRelease config in Skaffold. This allows users to skip refreshing Helm dependencies during builds, which can be useful for speeding up builds when dependencies haven't changed. The implementation looks good overall, and the documentation updates are clear. I've summarized the Google Go Style Guide elements I referenced below:

Naming: Used for the new option name BuildDependenciesSkipRefresh.
Comments/Documentation: Ensured the new option is documented clearly in the schema and the code.

Here are a few minor suggestions for improvement:

art-shutter · 2025-01-20T13:15:25Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

I did sign a CLA, can we re-run the check, please?

menahyouyeah · 2025-01-22T14:51:51Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).
View this failed invocation of the CLA check for more information.
For the most up to date status, view the checks section at the bottom of the pull request.

I did sign a CLA, can we re-run the check, please?

I reran it yesterday and today and looks like it's still failing

menahyouyeah · 2025-01-22T14:53:10Z

        "wait",
        "recreatePods",
        "skipBuildDependencies",
+        "buildDependenciesSkipRefresh",


to stay consistent with the other flag "skipBuildDependencies", can you rename to "skipBuildDependenciesRefresh"? I had to look up what the other one was doing and with this rename I think it will be clearer what each flag is doing

menahyouyeah · 2025-01-22T14:55:52Z

-		if err := helm.ExecWithStdoutAndStderr(ctx, h, io.Discard, errBuffer, false, env, "dep", "build", release.ChartPath); err != nil {
+		cmdArgs := []string{"dep", "build", release.ChartPath}
+		if release.BuildDependenciesSkipRefresh {
+			cmdArgs = []string{"dep", "build", "--skip-refresh", release.ChartPath}


instead of redefining, can you just += to cmdArgs slice? I.e. just add "--skip-refresh"? Does release.ChartPath have to be the last arg?

It doesn't have to be last in helm cli. Changed it to append instead of recreate.

menahyouyeah · 2025-01-22T15:02:16Z

-		if err := helm.ExecWithStdoutAndStderr(ctx, h, io.Discard, errBuffer, false, env, "dep", "build", release.ChartPath); err != nil {
+		cmdArgs := []string{"dep", "build", release.ChartPath}
+		if release.BuildDependenciesSkipRefresh {
+			cmdArgs = []string{"dep", "build", "--skip-refresh", release.ChartPath}


can you add a unit test for this?

moved to its own func and added a unit test

menahyouyeah · 2025-01-22T15:04:21Z

 	// Ignored for `remoteChart`.
 	SkipBuildDependencies bool `yaml:"skipBuildDependencies,omitempty"`

+	// BuildDependenciesSkipRefresh should the refresh of already built dependencies be skipped.


nit on grammar: determines whether the refresh of already built dependencies should be skipped. I'd also add that if it's set to true, the --skip-refresh flag is passed to the helm dep build command

…ping refresh of built dependencies

…esh and update related logic

art-shutter · 2025-01-29T08:58:31Z

I reran it yesterday and today and looks like it's still failing

I amended the commits to use the email address that was used to sing the CLA. The check is passing now

menahyouyeah · 2025-01-30T14:23:58Z

 		}

-		if err := os.WriteFile(constants.HelmOverridesFilename, overrides, 0666); err != nil {
+		if err := os.WriteFile(constants.HelmOverridesFilename, overrides, 0o666); err != nil {


just wondering why you changed this?

it's octal permissions, added by gofumpt automatically. I didn't intend this change as this is not the accepted tool in the repo. Reverted.

plumpy · 2025-01-30T15:48:40Z

Would this be better implemented as new manifests.helm.flags.depBuild option? Are there other flags that people might want to specify, and this would give them the flexibility to do so?

(edited to add:)
To clarify, I'm wondering if the config should instead support somethign like this:

manifests:
  helm:
    flags:
      depBuild: ["--skip-refresh"]

This means if there's some other flag another user wants in the future, they could immediately use it without adding yet another configuration option to the skaffold.yaml.

Curious if you have thoughts on this? (also @idsulik)

idsulik · 2025-01-30T17:27:42Z

Yes, I think it'll be better to avoid adding more and more flags into the skaffold's config, we should follow the install/upgrade flags and add depBuild under the flags, as @plumpy suggested, it'll allow users to specify other flags as well if they need them:

      --keyring string            keyring containing public keys (default "/Users/main/.gnupg/pubring.gpg")
      --skip-download-if-exists   skip download of the chart if it already exists in the charts directory
      --skip-refresh              do not refresh the local repository cache
      --verify                    verify the packages against signatures

art-shutter · 2025-01-31T13:28:49Z

here it is: #9696

art-shutter · 2025-03-07T11:19:33Z

closing this in favor of #9696

pull-request-size Bot added the size/S label Jan 20, 2025

ghost reviewed Jan 20, 2025

View reviewed changes

art-shutter marked this pull request as ready for review January 20, 2025 13:12

art-shutter requested a review from a team as a code owner January 20, 2025 13:12

art-shutter requested a review from mattsanta January 20, 2025 13:12

menahyouyeah self-assigned this Jan 22, 2025

menahyouyeah reviewed Jan 22, 2025

View reviewed changes

art-shutter added 2 commits January 28, 2025 23:25

feat: add buildDependenciesSkipRefresh option to HelmRelease for skip…

aadc1a4

…ping refresh of built dependencies

fix: rename buildDependenciesSkipRefresh to skipBuildDependenciesRefr…

e6a93b8

…esh and update related logic

pull-request-size Bot added size/M and removed size/S labels Jan 28, 2025

menahyouyeah previously approved these changes Jan 30, 2025

View reviewed changes

fix: revert gofumpt change

2f5dc55

art-shutter dismissed menahyouyeah’s stale review via 2f5dc55 January 30, 2025 14:52

art-shutter closed this Mar 7, 2025

Conversation

art-shutter commented Jan 20, 2025

Uh oh!

google-cla Bot commented Jan 20, 2025

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

art-shutter commented Jan 20, 2025

Uh oh!

menahyouyeah commented Jan 22, 2025

Uh oh!

menahyouyeah Jan 22, 2025

Choose a reason for hiding this comment

Uh oh!

menahyouyeah Jan 22, 2025

Choose a reason for hiding this comment

Uh oh!

art-shutter Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

menahyouyeah Jan 22, 2025

Choose a reason for hiding this comment

Uh oh!

art-shutter Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

menahyouyeah Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

art-shutter commented Jan 29, 2025

Uh oh!

menahyouyeah Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

art-shutter Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

plumpy commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

idsulik commented Jan 30, 2025

Uh oh!

art-shutter commented Jan 31, 2025

Uh oh!

art-shutter commented Mar 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

menahyouyeah Jan 22, 2025 •

edited

Loading

plumpy commented Jan 30, 2025 •

edited

Loading