GoogleContainerTools/skaffold

Expose option to suppress output from hooks runner

Open

#6,344 opened on Aug 2, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/hookshelp wantedkind/feature-requestpriority/p3

Description

From https://github.com/GoogleContainerTools/skaffold/pull/6337#discussion_r681211816:

we definitely can't use the deploy mute setting since the application logs are manually muted in-between dev loops using this setting. This will have the effect of never actually printing the container hook log messages, since the container hooks are always executed in-between dev loops.

As is, output from executing hooks scripts will always be surfaced to users, even when the logs for individual phases are suppressed. We should either:

  • tie the output of the hooks to the associated phase (e.g. pre-/post-deploy hooks tied to the deploy phase; or,
  • add an option to explicitly suppress output from hooks themselves, independent of their associated phase

Option 1 seems a bit cleaner, but Option 2 seems useful for users who have hooks with particularly verbose output.

Contributor guide

Tech stack
go
Domain
developer experiencecli
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
GoSkaffold codebaseHooks architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the hooks runner code in Skaffold, likely in files related to hooks or deploy phases. Review the discussion in PR #6337 for context on why the deploy mute setting cannot be reused. Propose implementation of either option: tying hook output to associated phase or adding a separate suppress option. Provide code changes and tests.
Expose option to suppress output from hooks runner · GoogleContainerTools/skaffold#6344 | Good First Issue