Add a transform to easily create `summary` tasks

Open
#71 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
ci-cd

Research direction

Start by reviewing the referenced Gecko code-review transform and kind.yml to understand how summary tasks wait for attributed tasks and notify consumers. Then inspect this repository's transform conventions. Done should include a transform supporting the proposed noop, require_pass, and custom behaviors, with their dependency and pass/fail semantics defined.

Written by the indexing model from the issue text.

Description

Often people want to have a task that can summarize the results of other tasks. Either the entire graph or some subset. In Gecko there's a code-review task that does just this:
https://searchfox.org/mozilla-central/source/taskcluster/ci/code-review/kind.yml

It basically waits for all tasks with the code-review attribute to finish, and then sends a pulse message to notify consumers that they're ready (the consumers do the actual status inspection).

I propose we:

  1. Create a transform file that does something similar to the code review transform
  2. Implement some pre-defined "behaviors" the task can follow. Here are some example behaviours:
  • noop - Task always passes, routes can notify that all tasks being summarized are finished
  • require_pass - Task passes if all dependencies pass, otherwise it fails (can be useful if using an on-exception notify route)
  • custom - Task runs some arbitrary command as normal (?)
Dominant language
Python
Stars
26
Forks
55
Avg merge
2d 6m
Merged PRs (30d)
15

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.

More from taskcluster/taskgraph

All issues in taskcluster/taskgraph

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.