tilt-dev / tilt-dev/tilt

Make it clearer where Tilt file watch rules come from

Open
#5,747 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs request enhancement
Dominant language
Go
Stars
10.1k
Forks
413
Avg merge
1d 10h
Merged PRs (30d)
6

Description

This request stems from #2169, where @kevin-lindsay-1 writes:

To me the product answer would be to make it clear which file(s) triggered an update in the UI, and where that particular inclusion or exclusion rule came from, and allow overrides. I should be allowed to shoot my own foot, but it should be obvious when I'm using it who is shooting my foot (me or tilt).

I don't have an issue with tilt having reasonable defaults, however I just don't want it to do magic that I could only discover via reading the "correct page" in the docs, and I always want to be able to control it at the end of the day.

Can we make it clearer where Tilt build context and file watch rules come from? There could be opportunities in Tilt's documentation, in build / live_update logs, and in the API.

The filewatch API gives detailed information about watch and ignore paths, but information related to the files excluded from the build context is more challenging to inspect through the API:

tilt get -ojsonpath="{.spec.contextIgnores}" dockerimage <image-name>

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the file_changes.html sections on where file watches come from and inspecting file watches, then examine the documented dockerimage contextIgnores query. Compare what the API exposes with the requested build/live_update log and documentation improvements; done means the source of build-context and file-watch rules is clearly inspectable.

Written by the indexing model from the issue text.

Assessment

Domain
api, devtools, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.