mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 06:05:44 +00:00
147 lines
4.5 KiB
ReStructuredText
147 lines
4.5 KiB
ReStructuredText
===============
|
|
Task Attributes
|
|
===============
|
|
|
|
Tasks can be filtered, for example to support "try" pushes which only perform a
|
|
subset of the task graph or to link dependent tasks. This filtering is the
|
|
difference between a full task graph and a target task graph.
|
|
|
|
Filtering takes place on the basis of attributes. Each task has a dictionary
|
|
of attributes and filters over those attributes can be expressed in Python. A
|
|
task may not have a value for every attribute.
|
|
|
|
The attributes, and acceptable values, are defined here. In general, attribute
|
|
names and values are the short, lower-case form, with underscores.
|
|
|
|
kind
|
|
====
|
|
|
|
A task's ``kind`` attribute gives the name of the kind that generated it, e.g.,
|
|
``build`` or ``spidermonkey``.
|
|
|
|
run_on_projects
|
|
===============
|
|
|
|
The projects where this task should be in the target task set. This is how
|
|
requirements like "only run this on inbound" get implemented. These are
|
|
either project names or the aliases
|
|
|
|
* `integration` -- integration branches
|
|
* `release` -- release branches including mozilla-central
|
|
* `all` -- everywhere (the default)
|
|
|
|
For try, this attribute applies only if ``-p all`` is specified. All jobs can
|
|
be specified by name regardless of ``run_on_projects``.
|
|
|
|
If ``run_on_projects`` is set to an empty list, then the task will not run
|
|
anywhere, unless its build platform is specified explicitly in try syntax.
|
|
|
|
task_duplicates
|
|
===============
|
|
|
|
This is used to indicate that we want multiple copies of the task created.
|
|
This feature is used to track down intermittent job failures.
|
|
|
|
If this value is set to N, the task-creation machinery will create a total of N
|
|
copies of the task. Only the first copy will be included in the taskgraph
|
|
output artifacts, although all tasks will be contained in the same taskGroup.
|
|
|
|
While most attributes are considered read-only, target task methods may alter
|
|
this attribute of tasks they include in the target set.
|
|
|
|
build_platform
|
|
==============
|
|
|
|
The build platform defines the platform for which the binary was built. It is
|
|
set for both build and test jobs, although test jobs may have a different
|
|
``test_platform``.
|
|
|
|
build_type
|
|
==========
|
|
|
|
The type of build being performed. This is a subdivision of ``build_platform``,
|
|
used for different kinds of builds that target the same platform. Values are
|
|
|
|
* ``debug``
|
|
* ``opt``
|
|
|
|
test_platform
|
|
=============
|
|
|
|
The test platform defines the platform on which tests are run. It is only
|
|
defined for test jobs and may differ from ``build_platform`` when the same binary
|
|
is tested on several platforms (for example, on several versions of Windows).
|
|
This applies for both talos and unit tests.
|
|
|
|
Unlike build_platform, the test platform is represented in a slash-separated
|
|
format, e.g., ``linux64/opt``.
|
|
|
|
unittest_suite
|
|
==============
|
|
|
|
This is the unit test suite being run in a unit test task. For example,
|
|
``mochitest`` or ``cppunittest``.
|
|
|
|
unittest_flavor
|
|
===============
|
|
|
|
If a unittest suite has subdivisions, those are represented as flavors. Not
|
|
all suites have flavors, in which case this attribute should be set to match
|
|
the suite. Examples: ``mochitest-devtools-chrome-chunked`` or ``a11y``.
|
|
|
|
unittest_try_name
|
|
=================
|
|
|
|
This is the name used to refer to a unit test via try syntax. It
|
|
may not match either of ``unittest_suite`` or ``unittest_flavor``.
|
|
|
|
talos_try_name
|
|
==============
|
|
|
|
This is the name used to refer to a talos job via try syntax.
|
|
|
|
test_chunk
|
|
==========
|
|
|
|
This is the chunk number of a chunked test suite (talos or unittest). Note
|
|
that this is a string!
|
|
|
|
e10s
|
|
====
|
|
|
|
For test suites which distinguish whether they run with or without e10s, this
|
|
boolean value identifies this particular run.
|
|
|
|
image_name
|
|
==========
|
|
|
|
For the ``docker_image`` kind, this attribute contains the docker image name.
|
|
|
|
nightly
|
|
=======
|
|
|
|
Signals whether the task is part of a nightly graph. Useful when filtering
|
|
out nightly tasks from full task set at target stage.
|
|
|
|
all_locales
|
|
===========
|
|
|
|
For the ``l10n`` and ``nightly-l10n`` kinds, this attribute contains the list
|
|
of relevant locales for the platform.
|
|
|
|
l10n_chunk
|
|
==========
|
|
For the ``l10n`` and ``nightly-l10n`` kinds, this attribute contains the chunk
|
|
number of the job. Note that this is a string!
|
|
|
|
chunk_locales
|
|
=============
|
|
For the ``l10n`` and ``nightly-l10n`` kinds, this attribute contains an array of
|
|
the individual locales this chunk is responsible for processing.
|
|
|
|
locale
|
|
======
|
|
For jobs that operate on only one locale, we set the attribute ``locale`` to the
|
|
specific locale involved. Currently this is only in l10n versions of the
|
|
``beetmover`` and ``balrog`` kinds.
|