GoogleContainerTools/skaffold

Feature Request: Provide a way for clients to know when a watched file has changed

Open

#6,769 opened on Oct 25, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/eventingarea/syncarea/watchbugbash/q4-2022help wantedkind/feature-requestpriority/p2source/partnerships

Description

Cloud Code is implementing "interactive watch mode" giving the user control over when to trigger a skaffold session. This takes the form of a button in the UI. It would be great if it could indicate to the user that something changed (mark it with an icon / enable it etc.) to help draw attention and visibly mark the state as dirty.

Feature request

Skaffold provides a way (e.g. an event through its API) that indicates that a file or files that Skaffold is watching has changed. It might be nice to know which files have changed, but the key part is just knowing when something changed.

Contributor guide

Tech stack
gokubernetesdockerrest api
Domain
apideveloper 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-2 days
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
Knowledge of GoFamiliarity with Skaffold architectureUnderstanding of file system events
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the existing event system in Skaffold (likely in pkg/skaffold/event) to understand how events are structured and consumed. Check the file watcher code in pkg/skaffold/watch to see where changes are detected. Propose an event type for file changes and expose it via the existing event API. No linked PRs or comments, so this is a fresh feature request with no prior discussion.