tilt-dev / tilt-dev/tilt

filter_yaml name parameter is a regex, is that behavior confusing?

Open
#3,082 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Background

When filter_yaml was implemented it was decided that all of the fields would be regexes, although this wasn't clearly documented. When https://github.com/windmilleng/tilt.build/pull/469 was merged there was a discussion about whether this behavior is confusing or not. For example, it might be surprising to a user that this filter call:

filter_yaml(rest, name='baz')

Would match names like "foobaz", "bazaar" or "foobazbar".

Question

Should we change the default behavior to not be regexes?

Should we make it more clear that these fields are regexes? (For example: we could rename the parameter name from name to name_regex

Something else?

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 internal/tiltfile/tiltfile_state.go at lines 1191-1197 and inspect how filter_yaml handles its fields. Review the linked tilt.build discussion and the examples in the issue, then define the expected matching behavior or naming/documentation change. Done means the selected behavior is implemented or clearly documented and covered by appropriate tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.