Bug 1582923 - Allow new task kinds to be defined in c-c. r=darktrojan
authorRob Lemley <rob@thunderbird.net>
Tue, 28 Jan 2020 22:44:28 -0500
changeset 37449 4ca5a41330ff98c4d610b53f38b9ac2268ef15be
parent 37448 ef52be64fc6dadd541c2cab2952ed1446f8d51b3
child 37450 0ebeb53641ffc6ba167f05f26ab585ad11371b93
push id2566
push userclokep@gmail.com
push dateMon, 09 Mar 2020 19:20:31 +0000
treeherdercomm-beta@a352facfa0a4 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdarktrojan
bugs1582923
Bug 1582923 - Allow new task kinds to be defined in c-c. r=darktrojan Task kind names must be documented in order to pass Taskcluster's verification routines. This registers a new documentation path with the verify_docs function so that it checks comm/taskcluster/docs/ for files as well. Kind names must appear as a heading in kinds.rst.
taskcluster/comm_taskgraph/__init__.py
taskcluster/comm_taskgraph/documentation.py
taskcluster/docs/kinds.rst
--- a/taskcluster/comm_taskgraph/__init__.py
+++ b/taskcluster/comm_taskgraph/__init__.py
@@ -19,17 +19,17 @@ BALROG_PRODUCT = 'Thunderbird'
 
 
 def register(graph_config):
     """
     Import all modules that are siblings of this one, triggering decorators in
     the process.
     """
     logger.info("{} path registered".format(__name__))
-    _import_modules([])
+    _import_modules(['documentation'])
 
 
 def _import_modules(modules):
     for module in modules:
         import_module(".{}".format(module), package=__name__)
 
 
 def get_decision_parameters(graph_config, parameters):
new file mode 100644
--- /dev/null
+++ b/taskcluster/comm_taskgraph/documentation.py
@@ -0,0 +1,14 @@
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+import os
+
+from . import COMM
+
+from taskgraph.util.verify import documentation_paths
+
+documentation_paths.add(os.path.join(COMM, 'taskcluster', 'docs'))
new file mode 100644
--- /dev/null
+++ b/taskcluster/docs/kinds.rst
@@ -0,0 +1,5 @@
+Task Kinds
+==========
+
+This section lists and documents the additional task kinds that are specific
+to Thunderbird and are implemented in it's source tree.