Getting Started

Getting Started#

This tutorial will guide you towards a working Taskcluster + Taskgraph setup with your repo in as few steps as possible.

Note

This tutorial has a heavy focus on the end result. If you prefer to build understanding as you go, you may wish to follow the Creating a Simple Task Graph and Submitting your Graph to Taskcluster tutorials instead.

There are three steps to getting running tasks:

  1. Define Tasks

  2. Request Permissions

  3. Install Taskcluster Github

Let’s dive into each!

Create Tasks#

The first step is to define your tasks. You’ll need:

  1. A Decision Task defined in .taskcluster.yml

  2. A Taskgraph setup in the taskcluster directory

Luckily Taskgraph provides an init command that can generate both of these things automatically! Run:

$ pip install taskcluster-taskgraph
$ taskgraph init

This will automatically generate all the necessary files. Commit what was generated:

$ git add .
$ git commit -m "Add Taskcluster files"

Land your changes on the default branch (typically main). Nothing will happen yet, but we need that .taskcluster.yml file to exist at the root of the repository for the next step.

Request Permissions#

Your repository now has some tasks defined, but it won’t have permission to run anything. In the Taskcluster world, permissions are also known as scopes. So the next step is to contact your Taskcluster administrators and request scopes for your project so that it has access to the resources it needs to run tasks.

Note

For Mozilla’s Firefox-CI instance, file a bug under Release Engineering :: Firefox-CI Administration

Use a title such as: Please setup `org/my-repo` with Taskcluster.

Install Taskcluster Github#

Note

If you are not using Github, skip this section and reach out to your Taskcluster administrators, there may be other steps to integrate your repository.

Each Taskcluster deployment has an associated Github app that needs to be added to your repo. If you are unsure which app your deployment uses, ask your Taskcluster administrators.

Note

The Github app for Mozilla’s Firefox-CI instance can be found here:

apps/firefoxci-taskcluster

Open the page of the Github app for your deployment and click Configure near the top right. Then select the repository you’d like to enable. If you are not an admin of the organization you are enabling the repo for, this will send a request to your Github administrators.

Note

If you do not see a Configure button, contact your Github administrators for assistance.

Now when you push, you should have a working Decision task that generates a hello-world task as well as a docker-image task that it depends on!

Further Reading#

Now that you have a working Taskcluster setup, explore these docs to learn more about using Taskgraph!

If you’d like to understand more about the files that the taskgraph init command generated, you can follow the Creating a Simple Task Graph and Submitting your Graph to Taskcluster tutorials

Check out the Concepts page if you’d like to learn more about how Taskgraph works.

Or if you are ready to dive into creating more tasks, you may wish to learn how to:

Contents