tilt-dev / tilt-dev/tilt

configs are hard to get working

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

Nobody has claimed this yet.

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

Description

From the #tilt channel:

I'm using tilt up -- --to-run frontend and then config.define_string_list("to-run", args=True) and print(cfg.get('to-run', [])) and I get Error: flag provided but not defined: -to-run

When I read the documentation myself, I was not able to get this to work, or adequately explain why it didn't work. (The problem is that args=True means "don't use the flag name on the command-line")

As I see it, there are a couple different problems here that might be worth separating:

  • The error message is poor. Tilt knows that to-run is a positional argument. Why can't it tell me that?
  • The documentation doesn't link to any working examples. When I tried to make a working example myself, I was not able to. Multiple people have complained that they were not able to get this working without hand-holding from the Tilt team

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 by reproducing tilt up -- --to-run frontend with config.define_string_list("to-run", args=True) and compare it with the documented configuration behavior. Review the CLI configuration documentation and any working examples you can locate; done means the positional-argument behavior is clearly explained, a working example is provided, and the error identifies the issue usefully.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.