taskcluster/docs/kinds.rst
author Andreas Pehrson <apehrson@mozilla.com>
Tue, 12 Nov 2019 10:30:16 +0000
changeset 501560 9e3f44e87a1a2be927c7fab135653c6b86b982c9
parent 499753 71344d6b59d5d8f1a2af6a1c07e563f8bf8c8ed3
permissions -rw-r--r--
Bug 1594466 - Don't rewrite mimeType if fully defined. r=bryce Prior to this patch the mimetype was rewritten per the printf format "%s; codecs=%s" also when codecs were defined in the constrained mime type. The latter '%s' would be the codecs string from the mime type parser, which would have dropped any quotation marks surrounding the string. Hence 'codecs="vp8, opus"' would be considered supported (quotation marks included), but when selecting mime type in start(), it would be rewritten with quotation marks dropped. Thus looking like 'codecs=vp8,' which is not supported. This patch removes the rewrite step when the mime type is fully defined with codecs, so that the quotation marks are left in place as given to the constructor. Differential Revision: https://phabricator.services.mozilla.com/D52520

Task Kinds
==========

This section lists and documents the available task kinds.

build
-----

Builds are tasks that produce an installer or other output that can be run by
users or automated tests.  This is more restrictive than most definitions of
"build" in a Mozilla context: it does not include tasks that run build-like
actions for static analysis or to produce instrumented artifacts.

build-fat-aar
-------------

Build architecture-independent GeckoView AAR (Android ARchive) files. This build-like tasks is an
artifact build (ARMv7, but this is arbitrary) that itself depends on arch-specific Android build
jobs. It fetches arch-specific AAR files, extracts arch-specific libraries and preference files,
and then assembles a multi-architecture "fat AAR". Downstream consumers are expected to use
per-ABI feature splits to produce arch-specific APKs.

If you want to run this task locally, you need to specify these environment variable:
  - MOZ_ANDROID_FAT_AAR_ARCHITECTURES: must be a comma-separated list of architecture.
    Eg: "armeabi-v7a,arm64-v8a,x86,x86_64".
  - each of MOZ_ANDROID_FAT_AAR_ARM64_V8A, MOZ_ANDROID_FAT_AAR_ARMEABI_V7A,
    MOZ_ANDROID_FAT_AAR_X86, MOZ_ANDROID_FAT_AAR_X86_64 must be a path relative to
    MOZ_FETCHES_DIR.

build-signing
-------------

Many builds must be signed. The build-signing task takes the unsigned `build`
kind artifacts and passes them through signingscriptworker to a signing server
and returns signed results.

artifact-build
--------------

This kind performs an artifact build: one based on precompiled binaries
discovered via the TaskCluster index.  This task verifies that such builds
continue to work correctly.

hazard
------

Hazard builds are similar to "regular' builds, but use a compiler extension to
extract a bunch of data from the build and then analyze that data looking for
hazardous behaviors.

l10n
----

The l10n kind takes the last published nightly build, and generates localized builds
from it. You can read more about how to trigger these on the `wiki
<https://wiki.mozilla.org/ReleaseEngineering/TryServer#Desktop_l10n_jobs_.28on_Taskcluster.29>`_.

nightly-l10n
------------

The nightly l10n kind repacks a specific nightly build (from the same source code)
in order to provide localized versions of the same source.

nightly-l10n-signing
--------------------

The nightly l10n signing kind takes artifacts from the nightly-l10n kind and
passes them to signing servers to have their contents signed appropriately, based
on an appropriate signing format. One signing job is created for each nightly-l10n
job (usually chunked).

source-test
-----------

Source-tests are tasks that run directly from the Gecko source. This can include linting,
unit tests, source-code analysis, or measurement work. While source-test tasks run from
a source checkout, it is still possible for them to depend on a build artifact, though
often they do not.

code-review
-----------

Publish issues found by source-test tasks on Phabricator.
This is a part of Release Management code review Bot.

upload-symbols
--------------

Upload-symbols tasks run after builds and upload the symbols files generated by
build tasks to Socorro for later use in crash analysis.

upload-generated-sources
------------------------

Upload-generated-sources tasks run after builds and upload source files that were generated as part of the build process to an s3 bucket for later use in links from crash reports or when debugging shipped builds.

valgrind
--------

Valgrind tasks produce builds instrumented by valgrind.

searchfox
---------

Searchfox builds generate C++ index data for Searchfox.

static-analysis-autotest
------------------------

Static analysis autotest utility in order to be sure that there is no regression
when upgrading utilities that impact static-analysis.

toolchain
---------

Toolchain builds create the compiler toolchains used to build Firefox.  These
will eventually be dependencies of the builds themselves, but for the moment
are run manually via try pushes and the results uploaded to tooltool.

spidermonkey
------------

Spidermonkey tasks check out the full gecko source tree, then compile only the
spidermonkey portion.  Each task runs specific tests after the build.

test
----

The ``desktop-test`` kind defines tests for builds.  Its ``tests.yml`` defines
the full suite of desktop tests and their particulars, leaving it to the
transforms to determine how those particulars apply to the various platforms.

The process of generating tests goes like this, based on a set of YAML files
named in ``kind.yml``:

 * For each build task, determine the related test platforms based on the build
   platform.  For example, a Windows 2010 build might be tested on Windows 7
   and Windows 10.  Each test platform specifies "test sets" indicating which
   tests to run.  This is configured in the file named
   ``test-platforms.yml``.

 * Each test set is expanded to a list of tests to run.  This is configured in
   the file named by ``test-sets.yml``. A platform may specify several test
   sets, in which case the union of those sets is used.

 * Each named test is looked up in the file named by ``tests.yml`` to find a
   test description.  This test description indicates what the test does, how
   it is reported to treeherder, and how to perform the test, all in a
   platform-independent fashion.

 * Each test description is converted into one or more tasks.  This is
   performed by a sequence of transforms defined in the ``transforms`` key in
   ``kind.yml``.  See :doc:`transforms`: for more information on these
   transforms.

 * The resulting tasks become a part of the task graph.

.. important::

    This process generates *all* test jobs, regardless of tree or try syntax.
    It is up to a later stages of the task-graph generation (the target set and
    optimization) to select the tests that will actually be performed.

docker-image
------------

Tasks of the ``docker-image`` kind build the Docker images in which other
Docker tasks run.

The tasks to generate each docker image have predictable labels:
``build-docker-image-<name>``.

Docker images are built from subdirectories of ``taskcluster/docker``, using
``docker build``.  There is currently no capability for one Docker image to
depend on another in-tree docker image, without uploading the latter to a
Docker repository.

balrog
------

Balrog tasks are responsible for submitting metadata to our update server (Balrog).
They are typically downstream of a beetmover job that moves signed MARs somewhere
(eg: beetmover and beetmover-l10n for releases, beetmover-repackage for nightlies).

beetmover
---------

Beetmover, takes specific artifacts, "Beets", and pushes them to a location outside
of Taskcluster's task artifacts, (archive.mozilla.org as one place) and in the
process determines the final location and a "pretty" name (versioned product name)

beetmover-l10n
--------------

Beetmover L10n, takes specific artifacts, "Beets", and pushes them to a location outside
of Taskcluster's task artifacts, (archive.mozilla.org as one place) and in the
process determines the final location and a "pretty" name (versioned product name)
This separate kind uses logic specific to localized artifacts, such as including
the language in the final artifact names.

beetmover-repackage
-------------------

Beetmover-repackage is beetmover but for tasks that need an intermediate step
between signing and packaging, such as OSX. For more details see the definitions
of the Beetmover kind above and the repackage kind below.

release-beetmover-push-to-release
---------------------------------

release-beetmover-push-to-release publishes promoted releases from the
candidates directory to the release directory. This is part of release
promotion.

beetmover-snap
--------------
Beetmover-source publishes Ubuntu's snap. This is part of release promotion.

beetmover-source
----------------
Beetmover-source publishes release source. This is part of release promotion.

beetmover-geckoview
-------------------
Beetmover-geckoview publishes the Android library called "geckoview".

condprof
--------
condprof creates and updates realistic profiles.

release-source-checksums-signing
--------------------------------
release-source-checksums-signing take as input the checksums file generated by
source-related beetmover task and sign it via the signing scriptworkers.
Returns the same file signed and additional detached signature.

beetmover-checksums
-------------------
Beetmover, takes specific artifact checksums and pushes it to a location outside
of Taskcluster's task artifacts (archive.mozilla.org as one place) and in the
process determines the final location and "pretty" names it (version product name)

release-beetmover-source-checksums
----------------------------------
Beetmover, takes source specific artifact checksums and pushes it to a location outside
of Taskcluster's task artifacts (archive.mozilla.org as one place) and in the
process determines the final location and "pretty" names it (version product name)

push-apk
--------
PushApk publishes Android packages onto Google Play Store. Jobs of this kind take
all the signed multi-locales (aka "multi") APKs for a given release and upload them
all at once.

push-apk-checks
---------------
Runs the checks done in push-apk to ensure APKs are sane before submitting them

release-balrog-submit-toplevel
------------------------------
Toplevel tasks are responsible for submitting metadata to Balrog that is not specific to any
particular platform+locale. For example: fileUrl templates, versions, and platform aliases.

Toplevel tasks are also responsible for updating test channel rules to point at the Release
being generated.

release-secondary-balrog-submit-toplevel
----------------------------------------
Performs the same function as `release-balrog-submit-toplevel`, but against the beta channel
during RC builds.

release-balrog-scheduling
-------------------------
Schedules a Release for shipping in Balrog. If a `release_eta` was provided when starting the Release,
it will be scheduled to go live at that day and time.

release-secondary-balrog-scheduling
-----------------------------------
Performs the same function as `release-balrog-scheduling`, except for the beta channel as part of RC
Releases.

release-binary-transparency
---------------------------
Binary transparency creates a publicly verifiable log of binary shas for downstream
release auditing. https://wiki.mozilla.org/Security/Binary_Transparency

release-snap-repackage
----------------------
Generate an installer using Ubuntu's Snap format.

release-snap-push
-----------------
Pushes Snap repackage on Snap store.

release-secondary-snap-push
---------------------------
Performs the same function as `release-snap-push`, except for the beta channel as part of RC
Releases.

release-notify-push
-------------------
Notify when a release has been pushed to CDNs.

release-notify-ship
-------------------
Notify when a release has been shipped.

release-secondary-notify-ship
-----------------------------
Notify when an RC release has been shipped to the beta channel.

release-notify-promote
----------------------
Notify when a release has been promoted.

release-notify-started
----------------------
Notify when a release has been started.

release-bouncer-sub
-------------------
Submits bouncer updates for releases.

release-bouncer-sub-nazgul
--------------------------
Submits bouncer updates for releases, using new implementation of bouncer-admin (Nazgul).

release-mark-as-shipped
-----------------------
Marks releases as shipped in Ship-It v1

release-bouncer-aliases
-----------------------
Update Bouncer's (download.mozilla.org) "latest" aliases.

cron-bouncer-check
------------------
Checks Bouncer (download.mozilla.org) uptake.

bouncer-locations
-----------------
Updates nightly bouncer locations for version bump

release-bouncer-check
---------------------
Checks Bouncer (download.mozilla.org) uptake as part of the release tasks.

release-generate-checksums
--------------------------
Generate the per-release checksums along with the summaries

release-generate-checksums-signing
----------------------------------
Sign the pre-release checksums produced by the above task

release-generate-checksums-beetmover
------------------------------------
Submit to S3 the artifacts produced by the release-checksums task and its signing counterpart.

release-final-verify
--------------------
Verifies the contents and package of release update MARs.

release-secondary-final-verify
------------------------------
Verifies the contents and package of release update MARs for RC releases.

release-push-langpacks
-------------------------------
Publishes language packs onto addons.mozilla.org.

release-beetmover-signed-langpacks
----------------------------------
Publishes signed langpacks to archive.mozilla.org

release-beetmover-signed-langpacks-checksums
--------------------------------------------
Publishes signed langpacks to archive.mozilla.org

release-update-verify
---------------------
Verifies the contents and package of release update MARs.
release-secondary-update-verify
-------------------------------
Verifies the contents and package of release update MARs.

release-update-verify-next
--------------------------
Verifies the contents and package of release and updare MARs from the previous ESR release.

release-update-verify-config
----------------------------
Creates configs for release-update-verify tasks

release-secondary-update-verify-config
--------------------------------------
Creates configs for release-secondary-update-verify tasks

release-update-verify-config-next
---------------------------------
Creates configs for release-update-verify-next tasks

release-updates-builder
-----------------------
Top level Balrog blob submission & patcher/update verify config updates.

release-version-bump
--------------------
Bumps to the next version.

release-source
--------------
Generates source for the release

release-source-signing
----------------------
Signs source for the release

release-partner-repack
----------------------
Generates customized versions of releases for partners.

release-partner-repack-chunking-dummy
-------------------------------------
Chunks the partner repacks by locale.

release-partner-repack-signing
------------------------------
Internal signing of partner repacks.

release-partner-repack-repackage
--------------------------------
Repackaging of partner repacks.

release-partner-repack-repackage-signing
----------------------------------------
External signing of partner repacks.

release-partner-repack-beetmover
--------------------------------
Moves the partner repacks to S3 buckets.

release-partner-repack-bouncer-sub
----------------------------------
Sets up bouncer products for partners.


release-early-tagging
---------------------
Utilises treescript to perform tagging that should happen near the start of a release.

release-eme-free-repack
-----------------------
Generates customized versions of releases for eme-free repacks.

release-eme-free-repack-signing
-------------------------------
Internal signing of eme-free repacks

release-eme-free-repack-repackage
---------------------------------
Repackaging of eme-free repacks.

release-eme-free-repack-repackage-signing
-----------------------------------------
External signing of eme-free repacks.

release-eme-free-repack-beetmover
---------------------------------
Moves the eme-free repacks to S3 buckets.

release-eme-free-repack-beetmover-checksums
-------------------------------------------
Moves the beetmover checksum for eme-free repacks to S3 buckets.

repackage
---------
Repackage tasks take a signed output and package them up into something suitable
for shipping to our users. For example, on OSX we return a tarball as the signed output
and this task would package that up as an Apple Disk Image (.dmg)

repackage-l10n
--------------
Repackage-L10n is a ```Repackage``` task split up to be suitable for use after l10n repacks.


repackage-signing
-----------------
Repackage-signing take the repackaged installers (windows) and signs them.

repackage-signing-l10n
----------------------
Repackage-signing-l10n take the repackaged installers (windows) and signs them for localized versions.

mar-signing
-----------
Mar-signing takes the complete update MARs and signs them.

mar-signing-l10n
----------------
Mar-signing-l10n takes the complete update MARs and signs them for localized versions.

mar-signing-autograph-stage
---------------------------
These tasks are only to test autograph-stage, when the autograph team asks for their staging environment to be tested.

repackage-msi
-------------
Repackage-msi takes the signed full installer and produces an msi installer (that wraps the full installer)
Using the ```./mach repackage``` command

repackage-signing-msi
---------------------
Repackage-signing-msi takes the repackaged msi installers and signs them.

repo-update
-----------
Repo-Update tasks are tasks that perform some action on the project repo itself,
in order to update its state in some way.

pipfile-update
--------------
Pipfile-update tasks generate update Pipfile.lock for in-tree Pipfiles, and attach
patches with the updates to Phabricator.

partials
--------
Partials takes the complete.mar files produced in previous tasks and generates partial
updates between previous nightly releases and the new one. Requires a release_history
in the parameters. See ``mach release-history`` if doing this manually.

partials-signing
----------------
Partials-signing takes the partial updates produced in Partials and signs them.

post-balrog-dummy
-----------------
Dummy tasks to consolidate balrog dependencies to avoid taskcluster limits on number of dependencies per task.

post-beetmover-dummy
--------------------
Dummy tasks to consolidate beetmover dependencies to avoid taskcluster limits on number of dependencies per task.

post-beetmover-checksums-dummy
------------------------------
Dummy tasks to consolidate beetmover-checksums dependencies to avoid taskcluster limits on number of dependencies per task.

post-langpack-dummy
-------------------
Dummy tasks to consolidate language pack beetmover dependencies to avoid taskcluster limits on number of dependencies per task.

fetch
-----
Tasks that obtain something from a remote service and re-expose it as a
task artifact. These tasks are used to effectively cache and re-host
remote content so it is reliably and deterministically available.

packages
--------
Tasks used to build packages for use in docker images.

diffoscope
----------
Tasks used to compare pairs of Firefox builds using https://diffoscope.org/.
As of writing, this is mainly meant to be used in try builds, by editing
taskcluster/ci/diffoscope/kind.yml for your needs.

addon
-----
Tasks used to build/package add-ons.

openh264-plugin
---------------
Tasks used to build the openh264 plugin.

openh264-signing
----------------
Signing for the openh264 plugin.

webrender
---------
Tasks used to do testing of WebRender standalone (without gecko). The
WebRender code lives in gfx/wr and has its own testing infrastructure.

instrumented-build
------------------
Tasks that generate builds with PGO instrumentation enabled. This is an
intermediate build that can be used to generate profiling information for a
final PGO build. This is the 1st stage of the full 3-step PGO process.

generate-profile
----------------
Tasks that take a build configured for PGO and run the binary against a sample
set to generate profile data. This is the 2nd stage of the full 3-step PGO
process.

geckodriver-repack
------------------
Tasks to repackage the geckodriver binary from a build tasks's common
test archive into it's own archive.

geckodriver-signing
-------------------
Signing for geckodriver binary.

visual-metrics
--------------
Tasks that compute visual performance metrics from videos and images captured
by other tasks.

visual-metrics-dep
------------------
Tasks that compute visual performance metrics from videos and images captured
by another task that produces a jobs.json artifact

iris
----
Iris testing suite