tilt-dev / tilt-dev/tilt

failure help text

Open
#4,554 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

When you're writing any kind of build/deploy job, often there's a known set of failure cases and a playbook on how to deal with them.

Ideally, the Tilt UI would be customizable to that you could show that playbook in a prominent location.

Example:
docker pull failed: please see https://go/gcr-local (instructions on how to authenticate to docker)

For bonus points, you could only trigger this message if a particular string is in the logs

Additional context
You can accomplish this now with wrapper scripts around your local resource (e.g., check the error code on a subprocess), but it's a bit awkward and doesn't have any UI support.

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

The issue does not identify files, tests, or an entry point. Start by tracing how Tilt displays local resource failures and exposes resource configuration, then determine how customizable playbook text and optional log-string matching could fit; done means a resource can show the relevant help prominently when its failure condition occurs.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.