triage-party

README

Triage Party 🎉

NOTE: This is not an officially supported Google product

Triage Party is a tool for triaging incoming GitHub issues for large open-source projects, built with the GitHub API.

Triage Party focuses on reducing response latency for incoming GitHub issues and PR's, and ensure that conversations are not lost in the ether. It was built from the Google Container DevEx team's experience contributing to popular open-source projects, such as minikube, Skaffold, and Kaniko.

Triage Party is a stateless Go web application, configured via YAML. While it has been optimized for Google Cloud Run deployments, it's deployable anywhere due to its low memory footprint: even on a Raspberry Pi.

Novel Features

• Conversation direction tracking (tag: recv, tag: send)
• Multiplayer mode: Up to 20 simultaneous players in group triage
• Query across GitHub projects or repositories
• Duplicate issue detection (tag: similar)
• Filters that are not possible on GitHub:
  • Follow-up latency by project members (responded: +15d)
  • Reactions (reactions: >=5)
  • Comment popularity (comments-per-month: >0.9)
• Easily open groups of issues into browser tabs
• YAML configuration for all pages, rules, and filters
• GitHub Enterprise support (via --github-api-url cli flag)
• Low latency (yet able to pull live data)

Triage Party in production

See these fine examples in the wild:

• kubernetes/minikube
• GoogleContainerTools/skaffold
• jetstack/cert-manager

Requirements

• GitHub API token with read access

Try it

Store a GitHub token some place on disk:

echo YOUR_GENERATED_TOKEN > $HOME/.github-token

Run:

go run cmd/server/main.go \
  --github-token-file=$HOME/.github-token \
  --config config/examples/kubernetes.yaml \
  --repos kubernetes/sig-release

If you do not have Go installed, you can run Triage Party using Docker:

docker build --tag=tp .
docker run -e GITHUB_TOKEN=$(cat $HOME/.github-token) -p 8080:8080 tp

You'll see logs emitted as Triage Party pulls content from GitHub. The first time a new repository is used, it will require some time (~45s in this case) to download the necessary data before minikube will render pages. Your new Triage Party site is now available at http://localhost:8080/, but will initially block page loads until the required content has been downloaded. After the first run, pages are rendered from memory within ~5ms.

Usage Tips

Triage Party can be configured to accept any triage workflow you can imagine. Here are some tips:

• Use the blue box-with-arrow icon to open issues/pull requests into a new tab
  • If nothing happens when clicked, your browser may be blocking pop-ups
  • The notification to allow-popups for Triage Party may be hidden in the URL bar.
• Rules work best when there is a documented resolution to remove it from the list
• Pages work best if the process is defined so that the page is empty when triage is complete
• If an non-actionable issue is shown as part of a daily or weekly triage, step back to tune your rules and/or define an appropriate resolution.

Multi-player mode

Use the drop-down labelled Solo on the top-right of any page to enable multi-player mode. In multi-player mode, the number of issues are split among the number of players you have configured. Since Triage Party is state-less, players are assigned via the remainder of the issue or PR divided by the total number of players. Here is a workflow that we have seen work well for triage parties:

1. Wait for attendees to show up
2. The meeting host selects the appropriate number of players, and shares the resulting Triage Party URL
3. If someone is showing up later, we may leave a slot open and re-shard later if they do not appear
4. The meeting host assigns each attendee a player number
5. Players move section by section, using the "open items in new tabs" feature to quickly work through issues
6. When a player does not have the context necessary to resolve an item, they present their screen and discuss it with the other players
7. When a player leaves, the meeting host "re-shards", and all players select the updated player count in the drop-down

NOTE: Multi-player works best if the "Resolution" field of each rule has a clear action to resolve the item and remove it from the list.

Data freshness

With the default Dockerfile, Triage Party refreshes data at least every 8 minutes, settable using the --max-refresh flag. Triage Party will give popular pages a higher refresh rate, up to every 30 seconds by default (settable using --min-refresh flag). This default is conservative, allowing Triage Party to work with repositories containing 10,000 open issues without hitting GitHub API limits.

Live data can be requested at any time by using forcing a refresh in their browser, typically by holding the Shift button as you reload the page. See forced refresh for your browser.

You can see how fresh a pages data is by mousing-over the "unique items" text in the top-center of the page.

Documentation

Thirsting for more? See:

• Configuration guide
• Deployment guide
• Persistent cache configuration