taskcluster-taskgraph 24.8.0__tar.gz → 25.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (276) hide show
  1. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/CHANGELOG.md +23 -0
  2. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/PKG-INFO +3 -4
  3. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/README.rst +1 -1
  4. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/index.rst +1 -0
  5. taskcluster_taskgraph-25.0.0/docs/howto/use-secrets.rst +98 -0
  6. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/migrations.rst +5 -0
  7. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/run-task.rst +45 -7
  8. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/sphinx-taskgraph/pyproject.toml +2 -2
  9. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/sphinx-taskgraph/src/sphinx_taskgraph/__init__.py +12 -4
  10. taskcluster_taskgraph-25.0.0/packages/sphinx-taskgraph/src/sphinx_taskgraph/autoschema.py +303 -0
  11. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/pyproject.toml +3 -4
  12. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/config.py +30 -30
  13. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/decision.py +1 -2
  14. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/docker.py +14 -14
  15. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/generator.py +4 -3
  16. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/parameters.py +5 -6
  17. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/run-task/run-task +226 -35
  18. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/task.py +3 -3
  19. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/base.py +2 -3
  20. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/chunking.py +7 -8
  21. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/docker_image.py +18 -19
  22. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/fetch.py +58 -55
  23. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/from_deps.py +8 -8
  24. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/matrix.py +18 -19
  25. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/notify.py +27 -27
  26. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/run/__init__.py +148 -36
  27. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/run/common.py +2 -2
  28. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/run/index_search.py +2 -2
  29. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/run/run_task.py +25 -25
  30. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/run/toolchain.py +16 -16
  31. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/task.py +180 -173
  32. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/task_context.py +51 -52
  33. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/dependencies.py +1 -2
  34. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/docker.py +1 -2
  35. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/json.py +2 -1
  36. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/schema.py +39 -37
  37. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/taskcluster.py +2 -2
  38. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/vcs.py +13 -14
  39. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/verify.py +2 -2
  40. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/skopeo/Dockerfile +1 -1
  41. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/skopeo/push_image.sh +3 -7
  42. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/codecov/kind.yml +6 -3
  43. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/complete/kind.yml +1 -1
  44. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/docker-image/kind.yml +1 -1
  45. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/push-image/kind.yml +5 -3
  46. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/test/linux.yml +3 -3
  47. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/scripts/codecov-upload.py +1 -16
  48. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/self_taskgraph/custom_parameters.py +2 -2
  49. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_parameters.py +1 -2
  50. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_scripts_run_task.py +325 -1
  51. taskcluster_taskgraph-25.0.0/test/test_transforms_run.py +380 -0
  52. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_task.py +41 -0
  53. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_schema.py +4 -3
  54. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/uv.lock +92 -1892
  55. taskcluster_taskgraph-24.8.0/packages/sphinx-taskgraph/src/sphinx_taskgraph/autoschema.py +0 -179
  56. taskcluster_taskgraph-24.8.0/test/test_transforms_run.py +0 -196
  57. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.codespell-ignore-words.txt +0 -0
  58. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.github/CODEOWNERS +0 -0
  59. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.github/workflows/codeql-analysis.yml +0 -0
  60. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.github/workflows/codspeed.yml +0 -0
  61. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.github/workflows/pypi-publish.yml +0 -0
  62. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.gitignore +0 -0
  63. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.pre-commit-config.yaml +0 -0
  64. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.readthedocs.yaml +0 -0
  65. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.taskcluster.yml +0 -0
  66. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/.yamllint +0 -0
  67. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/CODE_OF_CONDUCT.md +0 -0
  68. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/CONTRIBUTING.rst +0 -0
  69. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/LICENSE +0 -0
  70. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/Makefile +0 -0
  71. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/index.rst +0 -0
  72. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/kind.rst +0 -0
  73. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/loading.rst +0 -0
  74. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/optimization.rst +0 -0
  75. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/overview.rst +0 -0
  76. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/scopes.rst +0 -0
  77. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/task-graphs.rst +0 -0
  78. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/concepts/transforms.rst +0 -0
  79. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/conf.py +0 -0
  80. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/contributing.rst +0 -0
  81. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/glossary.rst +0 -0
  82. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/bootstrap-taskgraph.rst +0 -0
  83. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/create-actions.rst +0 -0
  84. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/create-tasks.rst +0 -0
  85. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/debugging.rst +0 -0
  86. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/define-schemas.rst +0 -0
  87. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/docker.rst +0 -0
  88. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/load-task-locally.rst +0 -0
  89. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/resolve-keyed-by.rst +0 -0
  90. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/run-locally.rst +0 -0
  91. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/send-notifications.rst +0 -0
  92. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/howto/use-fetches.rst +0 -0
  93. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/index.rst +0 -0
  94. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/cli.rst +0 -0
  95. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/index.rst +0 -0
  96. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/optimization-strategies.rst +0 -0
  97. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/parameters.rst +0 -0
  98. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/modules.rst +0 -0
  99. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.actions.rst +0 -0
  100. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.loader.rst +0 -0
  101. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.optimize.rst +0 -0
  102. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.rst +0 -0
  103. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.transforms.rst +0 -0
  104. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.transforms.run.rst +0 -0
  105. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/source/taskgraph.util.rst +0 -0
  106. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/transforms/chunking.rst +0 -0
  107. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/transforms/from_deps.rst +0 -0
  108. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/transforms/index.rst +0 -0
  109. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/transforms/matrix.rst +0 -0
  110. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/reference/transforms/task_context.rst +0 -0
  111. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/tutorials/connecting-taskcluster.rst +0 -0
  112. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/tutorials/creating-a-task-graph.rst +0 -0
  113. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/tutorials/example-taskcluster.yml +0 -0
  114. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/tutorials/getting-started.rst +0 -0
  115. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/docs/tutorials/index.rst +0 -0
  116. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/make.bat +0 -0
  117. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/pytest-taskgraph/README.md +0 -0
  118. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/pytest-taskgraph/pyproject.toml +0 -0
  119. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/pytest-taskgraph/src/pytest_taskgraph/__init__.py +0 -0
  120. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/pytest-taskgraph/src/pytest_taskgraph/fixtures/gen.py +0 -0
  121. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/pytest-taskgraph/src/pytest_taskgraph/fixtures/vcs.py +0 -0
  122. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/packages/sphinx-taskgraph/README.md +0 -0
  123. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/renovate.json +0 -0
  124. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/__init__.py +0 -0
  125. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/__init__.py +0 -0
  126. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/add_new_jobs.py +0 -0
  127. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/cancel.py +0 -0
  128. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/cancel_all.py +0 -0
  129. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/rebuild_cached_tasks.py +0 -0
  130. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/registry.py +0 -0
  131. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/retrigger.py +0 -0
  132. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/actions/util.py +0 -0
  133. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/create.py +0 -0
  134. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/filter_tasks.py +0 -0
  135. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/graph.py +0 -0
  136. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/loader/__init__.py +0 -0
  137. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/loader/default.py +0 -0
  138. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/loader/transform.py +0 -0
  139. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/main.py +0 -0
  140. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/morph.py +0 -0
  141. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/optimize/__init__.py +0 -0
  142. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/optimize/base.py +0 -0
  143. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/optimize/strategies.py +0 -0
  144. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/run-task/fetch-content +0 -0
  145. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/run-task/hgrc +0 -0
  146. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/run-task/robustcheckout.py +0 -0
  147. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/target_tasks.py +0 -0
  148. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/taskgraph.py +0 -0
  149. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/__init__.py +0 -0
  150. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/cached_tasks.py +0 -0
  151. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/transforms/code_review.py +0 -0
  152. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/__init__.py +0 -0
  153. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/archive.py +0 -0
  154. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/attributes.py +0 -0
  155. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/cached_tasks.py +0 -0
  156. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/caches.py +0 -0
  157. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/copy.py +0 -0
  158. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/hash.py +0 -0
  159. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/keyed_by.py +0 -0
  160. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/memory.py +0 -0
  161. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/parameterization.py +0 -0
  162. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/path.py +0 -0
  163. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/python_path.py +0 -0
  164. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/readonlydict.py +0 -0
  165. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/set_name.py +0 -0
  166. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/shell.py +0 -0
  167. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/task_context.py +0 -0
  168. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/taskgraph.py +0 -0
  169. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/templates.py +0 -0
  170. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/time.py +0 -0
  171. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/treeherder.py +0 -0
  172. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/workertypes.py +0 -0
  173. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/src/taskgraph/util/yaml.py +0 -0
  174. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/config.yml +0 -0
  175. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/REGISTRY +0 -0
  176. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/decision/Dockerfile +0 -0
  177. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/decision/HASH +0 -0
  178. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/decision/README.md +0 -0
  179. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/decision/VERSION +0 -0
  180. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/decision/system-setup.sh +0 -0
  181. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/fetch/Dockerfile +0 -0
  182. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/image_builder/README.rst +0 -0
  183. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/index-task/Dockerfile +0 -0
  184. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/index-task/README +0 -0
  185. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/index-task/insert-indexes.js +0 -0
  186. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/index-task/package.json +0 -0
  187. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/index-task/yarn.lock +0 -0
  188. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/python/Dockerfile +0 -0
  189. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/run-task/Dockerfile +0 -0
  190. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/run-task/system-setup.sh +0 -0
  191. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/docker/skopeo/policy.json +0 -0
  192. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/check/kind.yml +0 -0
  193. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/doc/kind.yml +0 -0
  194. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/fetch/kind.yml +0 -0
  195. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/test/kind.yml +0 -0
  196. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/kinds/test/windows.yml +0 -0
  197. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/self_taskgraph/__init__.py +0 -0
  198. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/self_taskgraph/custom_target_tasks.py +0 -0
  199. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/self_taskgraph/transforms/add_pr_route.py +0 -0
  200. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/self_taskgraph/transforms/push_image.py +0 -0
  201. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/test/params/main-repo-pull-request-untrusted.yml +0 -0
  202. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/test/params/main-repo-pull-request.yml +0 -0
  203. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/test/params/main-repo-push.yml +0 -0
  204. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/test/params/main-repo-release-pytest-taskgraph.yml +0 -0
  205. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/taskcluster/test/params/main-repo-release-taskcluster-taskgraph.yml +0 -0
  206. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/cookiecutter.json +0 -0
  207. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/hooks/post_gen_project.py +0 -0
  208. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/{{cookiecutter.project_name}}/taskcluster/config.yml +0 -0
  209. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/{{cookiecutter.project_name}}/taskcluster/docker/linux/Dockerfile +0 -0
  210. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/{{cookiecutter.project_name}}/taskcluster/kinds/docker-image/kind.yml +0 -0
  211. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/{{cookiecutter.project_name}}/taskcluster/kinds/hello/kind.yml +0 -0
  212. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/{{cookiecutter.project_name}}/taskcluster/{{cookiecutter.project_slug}}_taskgraph/transforms/hello.py +0 -0
  213. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/template/{{cookiecutter.project_name}}/taskcluster.github.yml +0 -0
  214. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/__init__.py +0 -0
  215. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/automationrelevance.json +0 -0
  216. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/conftest.py +0 -0
  217. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/task_context.yml +0 -0
  218. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/config.yml +0 -0
  219. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/docker/hello-world/Dockerfile +0 -0
  220. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/docker/hello-world-tag/Dockerfile +0 -0
  221. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/docker/hello-world-tag/REGISTRY +0 -0
  222. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/docker/hello-world-tag/VERSION +0 -0
  223. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/kinds/docker-image/kind.yml +0 -0
  224. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/scripts/toolchain/run.ps1 +0 -0
  225. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/scripts/toolchain/run.sh +0 -0
  226. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/taskcluster/test_taskgraph/transforms/foo.py +0 -0
  227. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/data/testmod/thing.py +0 -0
  228. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/mockedopen.py +0 -0
  229. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_actions_rebuild_cached_tasks.py +0 -0
  230. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_actions_registry.py +0 -0
  231. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_config.py +0 -0
  232. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_create.py +0 -0
  233. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_decision.py +0 -0
  234. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_docker.py +0 -0
  235. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_generator.py +0 -0
  236. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_graph.py +0 -0
  237. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_graph_perf.py +0 -0
  238. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_main.py +0 -0
  239. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_morph.py +0 -0
  240. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_optimize.py +0 -0
  241. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_optimize_strategies.py +0 -0
  242. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_scripts_fetch_content.py +0 -0
  243. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_target_tasks.py +0 -0
  244. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_taskgraph.py +0 -0
  245. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transform_chunking.py +0 -0
  246. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transform_docker_image.py +0 -0
  247. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transform_task_context.py +0 -0
  248. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_base.py +0 -0
  249. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_cached_tasks.py +0 -0
  250. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_fetch.py +0 -0
  251. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_from_deps.py +0 -0
  252. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_matrix.py +0 -0
  253. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_notify.py +0 -0
  254. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_run_run_task.py +0 -0
  255. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_transforms_run_toolchain.py +0 -0
  256. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_archive.py +0 -0
  257. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_attributes.py +0 -0
  258. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_cached_tasks.py +0 -0
  259. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_copy.py +0 -0
  260. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_dependencies.py +0 -0
  261. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_docker.py +0 -0
  262. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_json.py +0 -0
  263. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_keyed_by.py +0 -0
  264. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_memory.py +0 -0
  265. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_parameterization.py +0 -0
  266. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_path.py +0 -0
  267. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_python_path.py +0 -0
  268. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_readonlydict.py +0 -0
  269. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_taskcluster.py +0 -0
  270. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_templates.py +0 -0
  271. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_time.py +0 -0
  272. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_treeherder.py +0 -0
  273. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_vcs.py +0 -0
  274. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_verify.py +0 -0
  275. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_workertypes.py +0 -0
  276. {taskcluster_taskgraph-24.8.0 → taskcluster_taskgraph-25.0.0}/test/test_util_yaml.py +0 -0
@@ -1,5 +1,28 @@
1
1
  # Change Log
2
2
 
3
+ ## [25.0.0] - 2026-11-18
4
+
5
+ ### Changed
6
+
7
+ - run-task: send SIGTERM to the task's processes shortly before maxRunTime
8
+
9
+ ### Fixed
10
+
11
+ - run-task: don't let git hang if prompted for credentials (bug 2094225)
12
+
13
+ ### Removed
14
+
15
+ - BREAKING CHANGE: Dropped support for Python 3.9
16
+
17
+ ## [24.9.0] - 2026-11-16
18
+
19
+ ### Added
20
+
21
+ - run-task: fetch Taskcluster secrets listed in `RUN_TASK_SECRETS` env, into
22
+ an env or a file
23
+ - `secrets` key in run descriptions, which sets `RUN_TASK_SECRETS` and adds
24
+ the required scopes and `taskcluster-proxy` feature
25
+
3
26
  ## [24.8.0] - 2026-11-12
4
27
 
5
28
  ### Added
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: taskcluster-taskgraph
3
- Version: 24.8.0
3
+ Version: 25.0.0
4
4
  Summary: Build taskcluster taskgraphs
5
5
  Project-URL: Repository, https://github.com/taskcluster/taskgraph
6
6
  Project-URL: Issues, https://github.com/taskcluster/taskgraph/issues
@@ -9,14 +9,13 @@ License-File: LICENSE
9
9
  Classifier: Development Status :: 5 - Production/Stable
10
10
  Classifier: Environment :: Console
11
11
  Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
12
- Classifier: Programming Language :: Python :: 3.9
13
12
  Classifier: Programming Language :: Python :: 3.10
14
13
  Classifier: Programming Language :: Python :: 3.11
15
14
  Classifier: Programming Language :: Python :: 3.12
16
15
  Classifier: Programming Language :: Python :: 3.13
17
16
  Classifier: Programming Language :: Python :: 3.14
18
17
  Classifier: Topic :: Software Development
19
- Requires-Python: >=3.9
18
+ Requires-Python: >=3.10
20
19
  Requires-Dist: appdirs>=1.4
21
20
  Requires-Dist: cookiecutter~=2.1
22
21
  Requires-Dist: json-e>=2.7
@@ -105,7 +104,7 @@ CI`_.
105
104
  Installation
106
105
  ------------
107
106
 
108
- Taskgraph supports Python 3.8 and up, and can be installed from Pypi:
107
+ Taskgraph supports Python 3.10 and up, and can be installed from Pypi:
109
108
 
110
109
  .. code-block::
111
110
 
@@ -68,7 +68,7 @@ CI`_.
68
68
  Installation
69
69
  ------------
70
70
 
71
- Taskgraph supports Python 3.8 and up, and can be installed from Pypi:
71
+ Taskgraph supports Python 3.10 and up, and can be installed from Pypi:
72
72
 
73
73
  .. code-block::
74
74
 
@@ -13,6 +13,7 @@ A collection of how-to guides.
13
13
  define-schemas
14
14
  resolve-keyed-by
15
15
  use-fetches
16
+ use-secrets
16
17
  docker
17
18
  create-actions
18
19
  send-notifications
@@ -0,0 +1,98 @@
1
+ Use Secrets
2
+ ===========
3
+
4
+ Tasks often need secrets such as API tokens or private keys. Taskgraph can
5
+ have ``run-task`` fetch these automatically.
6
+
7
+ Using Secrets
8
+ -------------
9
+
10
+ Secrets are implemented as part of the :mod:`~taskgraph.transforms.run`
11
+ transforms, and are fetched by ``run-task``. So make sure your task uses those
12
+ transforms and a ``run-task`` based ``run.using``:
13
+
14
+ .. code-block:: yaml
15
+
16
+ loader: taskgraph.loader.transform:loader
17
+
18
+ transforms:
19
+ - taskgraph.transforms.run:transforms
20
+ - taskgraph.transforms.task:transforms
21
+
22
+ Then list the secrets in the task's ``secrets`` key:
23
+
24
+ .. code-block:: yaml
25
+
26
+ tasks:
27
+ deploy:
28
+ run:
29
+ using: run-task
30
+ command: ./deploy.sh
31
+ secrets:
32
+ - type: github-repo-token
33
+ app: my-github-app
34
+ env: GITHUB_TOKEN
35
+ - type: secret
36
+ name: project/myproject/level-3/deploy
37
+ key: privkey
38
+ file: ~/.ssh/id_rsa
39
+
40
+ Here ``deploy.sh`` will find a GitHub token in the ``GITHUB_TOKEN`` env and a
41
+ ``~/.ssh/id_rsa`` file containing a private ssh key.
42
+
43
+ The transforms add the scopes each secret needs and enable the
44
+ ``taskclusterProxy`` feature, then pass the list to ``run-task`` in the
45
+ ``RUN_TASK_SECRETS`` environment variable. No two secrets can be exported to
46
+ the same variable or file, and a secret can't be exported to a variable that is
47
+ also set in ``worker.env``.
48
+
49
+ Substituting Values
50
+ -------------------
51
+
52
+ Secret names often depend on the level or project. Use the
53
+ :ref:`task_context <task_context transforms>` transforms, before the run
54
+ transforms, to substitute parameters into them:
55
+
56
+ .. code-block:: yaml
57
+
58
+ transforms:
59
+ - taskgraph.transforms.task_context
60
+ - taskgraph.transforms.run:transforms
61
+ - taskgraph.transforms.task:transforms
62
+
63
+ tasks:
64
+ deploy:
65
+ task-context:
66
+ from-parameters:
67
+ level: level
68
+ project: project
69
+ substitution-fields: [secrets]
70
+ run:
71
+ using: run-task
72
+ command: ./deploy.sh
73
+ secrets:
74
+ - type: secret
75
+ name: project/{project}/level-{level}/deploy
76
+ env: DEPLOY_TOKEN
77
+
78
+ Every string in ``secrets`` is formatted, so write a literal ``{`` or ``}`` as
79
+ ``{{`` or ``}}``. ``secrets`` can also be keyed by a value as a whole, but not
80
+ entry by entry.
81
+
82
+ Secret Types
83
+ ------------
84
+
85
+ ``github-repo-token``
86
+ An installation token of the GitHub App ``app``. ``repo`` defaults to the
87
+ ``base_repository`` parameter, ``permissions`` to ``{"contents": "read"}``
88
+ and ``env`` to ``GITHUB_TOKEN``. Adds an
89
+ ``auth:github-repo-token:<app>/<owner>/<repo>:<permission>:<level>`` scope
90
+ for each permission.
91
+
92
+ ``secret``
93
+ A secret from Taskcluster's secrets service, exported to ``env`` or written
94
+ to ``file``. ``key`` exports a single key of the secret instead, using dots
95
+ for nested keys such as ``foo.bar``. Adds a ``secrets:get:<name>`` scope.
96
+
97
+ See :ref:`run-task-secrets` for the details of each type, including what
98
+ happens when a secret can't be fetched.
@@ -3,6 +3,11 @@ Migration Guide
3
3
 
4
4
  This page can help when migrating Taskgraph across major versions.
5
5
 
6
+ 24.x -> 25.x
7
+ ------------
8
+
9
+ * Upgrade to Python 3.10 or above.
10
+
6
11
  23.x -> 24.x
7
12
  ------------
8
13
 
@@ -24,10 +24,24 @@ the task can both use them. List them as JSON in ``RUN_TASK_SECRETS``:
24
24
  - type: github-repo-token
25
25
  app: read
26
26
  repo: https://github.com/myorg/myrepo
27
+ - type: secret
28
+ name: project/myproject/level-3/deploy
29
+ key: token
30
+ env: DEPLOY_TOKEN
27
31
 
28
- The only type so far is ``github-repo-token``. It asks Taskcluster's auth service
29
- for an installation token of the GitHub App ``app``, scoped to ``repo``. Its
30
- keys are:
32
+ Each entry has a ``type``, which decides its other keys. An unknown ``type`` or
33
+ key, or invalid JSON, fails the task. A variable that is already set is never
34
+ replaced.
35
+
36
+ Rather than setting ``RUN_TASK_SECRETS`` by hand, tasks using the
37
+ :mod:`~taskgraph.transforms.run` transforms can list secrets in their
38
+ ``secrets`` key. See :doc:`/howto/use-secrets`.
39
+
40
+ github-repo-token
41
+ ~~~~~~~~~~~~~~~~~
42
+
43
+ Asks Taskcluster's auth service for an installation token of the GitHub App
44
+ ``app``, scoped to ``repo``. Its keys are:
31
45
 
32
46
  ``app`` (required)
33
47
  The name of the GitHub App registered with Taskcluster.
@@ -37,7 +51,7 @@ keys are:
37
51
  The token's permissions. Defaults to ``{"contents": "read"}``.
38
52
  ``env``
39
53
  The environment variable to export the token in. Defaults to
40
- ``GITHUB_TOKEN``. A variable that is already set is never replaced.
54
+ ``GITHUB_TOKEN``.
41
55
 
42
56
  ``run-task`` also keeps the token for its own GitHub requests. The task needs
43
57
  the ``taskclusterProxy`` feature and an
@@ -45,9 +59,33 @@ the ``taskclusterProxy`` feature and an
45
59
  each permission. If a request fails, for example because a pull request from a
46
60
  fork lacks the scope, ``run-task`` logs a warning and carries on without the
47
61
  token. The same happens when the auth service rejects the request, such as for
48
- an unknown ``app`` or invalid ``permissions``. Invalid JSON, an unknown ``type``
49
- or key, or a ``repo`` that isn't on GitHub fails the task. Installation tokens
50
- expire after an hour.
62
+ an unknown ``app`` or invalid ``permissions``. A ``repo`` that isn't on GitHub
63
+ fails the task. Installation tokens expire after an hour.
64
+
65
+ secret
66
+ ~~~~~~
67
+
68
+ Fetches a secret from Taskcluster's secrets service. Its keys are:
69
+
70
+ ``name`` (required)
71
+ The name of the secret.
72
+ ``env``
73
+ The environment variable to export the secret in.
74
+ ``file``
75
+ The file to write the secret to. Relative paths are relative to the
76
+ task's working directory. Missing parent directories are created, and on
77
+ POSIX systems only the task's user can read the file. An existing file is
78
+ never replaced.
79
+ ``key``
80
+ A key of the secret to export, rather than the whole secret. Dots select
81
+ keys of nested objects, so ``foo.bar`` exports ``secret["foo"]["bar"]``.
82
+
83
+ Exactly one of ``env`` or ``file`` is required. A string value is written as
84
+ is, and any other value as JSON. If the variable is already set or the file
85
+ already exists, the secret isn't fetched. The task needs
86
+ the ``taskclusterProxy`` feature and a ``secrets:get:<name>`` scope. Unlike
87
+ ``github-repo-token``, a failure to fetch the secret, or a missing ``key``,
88
+ fails the task.
51
89
 
52
90
  .. _run-task-base-revisions:
53
91
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "sphinx-taskgraph"
3
- version = "0.1.0"
3
+ version = "0.2.0"
4
4
  description = "Sphinx extensions to assist with Taskgraph documentation"
5
5
  readme = "README.md"
6
6
  authors = [
@@ -8,7 +8,7 @@ authors = [
8
8
  ]
9
9
  dependencies = [
10
10
  "sphinx>=7.0.0",
11
- "voluptuous>=0.12.1",
11
+ "msgspec>=0.20.0",
12
12
  ]
13
13
 
14
14
  [build-system]
@@ -5,19 +5,27 @@
5
5
  Sphinx extension for rendering taskgraph schemas using autodoc with custom formatting.
6
6
  """
7
7
 
8
+ from importlib.metadata import version
9
+
8
10
 
9
11
  def setup(app):
10
12
  """
11
13
  Entry point for the Sphinx extension.
12
14
  """
13
- from .autoschema import SchemaDocumenter # noqa: PLC0415
15
+ from .autoschema import ( # noqa: PLC0415
16
+ process_docstring,
17
+ process_signature,
18
+ skip_member,
19
+ )
14
20
 
15
- # Register the custom autodocumenter.
16
- app.add_autodocumenter(SchemaDocumenter)
21
+ app.setup_extension("sphinx.ext.autodoc")
22
+ app.connect("autodoc-process-docstring", process_docstring)
23
+ app.connect("autodoc-process-signature", process_signature)
24
+ app.connect("autodoc-skip-member", skip_member)
17
25
 
18
26
  # Return metadata about the extension.
19
27
  return {
20
- "version": "1.0",
28
+ "version": version("sphinx-taskgraph"),
21
29
  "parallel_read_safe": True,
22
30
  "parallel_write_safe": True,
23
31
  }
@@ -0,0 +1,303 @@
1
+ # This Source Code Form is subject to the terms of the Mozilla Public
2
+ # License, v. 2.0. If a copy of the MPL was not distributed with this
3
+ # file, You can obtain one at http://mozilla.org/MPL/2.0/.
4
+
5
+ """
6
+ Autodoc integration for rendering msgspec based `taskgraph.util.schema.Schema`
7
+ classes.
8
+
9
+ Rather than relying on autodoc's default rendering (which shows Python
10
+ attribute names and the generated ``__init__`` signature), each schema class
11
+ gets a list of its fields as they would be written in YAML, along with their
12
+ types, defaults and descriptions.
13
+
14
+ Field descriptions are taken from ``#:`` comments (or attribute docstrings)
15
+ preceding each field, which Sphinx extracts from the source.
16
+ """
17
+
18
+ import json
19
+ import sys
20
+ import types
21
+ import typing as t
22
+ from functools import cache
23
+ from textwrap import dedent
24
+
25
+ import msgspec
26
+ import sphinx.ext.autodoc as autodoc
27
+ from sphinx.errors import PycodeError
28
+ from sphinx.pycode import ModuleAnalyzer
29
+
30
+ try:
31
+ from sphinx.ext.autodoc import _sentinels
32
+ except ImportError: # Sphinx < 9
33
+ _sentinels = None
34
+
35
+ # Placeholders autodoc passes to `autodoc-skip-member` in place of slotted
36
+ # attributes (like Struct fields), depending on the Sphinx version and whether
37
+ # the legacy class based implementation is in use.
38
+ SLOTS_SENTINELS = tuple(
39
+ obj
40
+ for obj in (
41
+ getattr(_sentinels, "SLOTS_ATTR", None),
42
+ getattr(autodoc, "SLOTSATTR", None),
43
+ )
44
+ if obj is not None
45
+ )
46
+
47
+
48
+ # `types.UnionType` (PEP 604 `X | Y` unions) only exists on Python 3.10+.
49
+ UNION_TYPES = (t.Union, getattr(types, "UnionType", t.Union))
50
+
51
+
52
+ def is_keyed_by(meta: t.Any) -> bool:
53
+ """Return True if `meta` is a `taskgraph.util.schema.OptionallyKeyedBy`.
54
+
55
+ Duck-typed to avoid depending on taskgraph itself.
56
+ """
57
+ return hasattr(meta, "fields") and hasattr(meta, "wrapped_type")
58
+
59
+
60
+ def is_struct(obj: t.Any) -> bool:
61
+ return isinstance(obj, type) and issubclass(obj, msgspec.Struct)
62
+
63
+
64
+ def is_canonical(cls: type) -> bool:
65
+ """Return True if `cls` can be referenced by its own name.
66
+
67
+ Classes created dynamically (e.g. via `Schema.from_dict`) are typically
68
+ not importable under their `__name__`, so they can't be cross-referenced
69
+ and need to be rendered inline instead.
70
+ """
71
+ module = sys.modules.get(cls.__module__)
72
+ return module is not None and getattr(module, cls.__qualname__, None) is cls
73
+
74
+
75
+ @cache
76
+ def _attr_docs(modname: str) -> dict[tuple[str, str], list[str]]:
77
+ try:
78
+ analyzer = ModuleAnalyzer.for_module(modname)
79
+ return analyzer.find_attr_docs()
80
+ except PycodeError:
81
+ return {}
82
+
83
+
84
+ def field_description(cls: type, name: str) -> list[str]:
85
+ """Return the doc comment lines for field `name` on `cls`.
86
+
87
+ Fields may be inherited, so look up the comment on the class that
88
+ actually defines the annotation.
89
+ """
90
+ for base in cls.__mro__:
91
+ if name in base.__dict__.get("__annotations__", {}):
92
+ docs = _attr_docs(base.__module__).get((base.__qualname__, name))
93
+ if docs:
94
+ return dedent("\n".join(docs)).strip("\n").splitlines()
95
+ return []
96
+ return []
97
+
98
+
99
+ def _literal(value: t.Any) -> str:
100
+ try:
101
+ text = json.dumps(value)
102
+ except (TypeError, ValueError):
103
+ text = repr(value)
104
+ return f"``{text}``"
105
+
106
+
107
+ def _class_ref(cls: type) -> str:
108
+ return f":class:`~{cls.__module__}.{cls.__qualname__}`"
109
+
110
+
111
+ class TypeFormatter:
112
+ """Formats a type annotation as reStructuredText.
113
+
114
+ Structs which can't be cross-referenced are collected in `inline` so
115
+ their fields can be rendered beneath the type line.
116
+ """
117
+
118
+ def __init__(self):
119
+ self.inline: list[type] = []
120
+
121
+ def __call__(self, tp: t.Any) -> str:
122
+ origin = t.get_origin(tp)
123
+ args = t.get_args(tp)
124
+
125
+ if origin is t.Annotated:
126
+ inner, *metadata = args
127
+ for meta in metadata:
128
+ if is_keyed_by(meta):
129
+ fields = ", ".join(sorted(f[3:] for f in meta.fields))
130
+ return f"optionally-keyed-by({fields}; {self(meta.wrapped_type)})"
131
+ return self(inner)
132
+
133
+ if origin in UNION_TYPES:
134
+ return " | ".join(self(a) for a in args)
135
+
136
+ if origin is t.Literal:
137
+ return " | ".join(_literal(a) for a in args)
138
+
139
+ if origin is not None:
140
+ name = getattr(origin, "__name__", str(origin))
141
+ if not args:
142
+ return name
143
+ return f"{name}[{', '.join(self(a) for a in args)}]"
144
+
145
+ if tp is type(None) or tp is None:
146
+ return "null"
147
+
148
+ if tp in (t.Any, object):
149
+ return "any"
150
+
151
+ if is_struct(tp):
152
+ if is_canonical(tp):
153
+ return _class_ref(tp)
154
+ if tp not in self.inline:
155
+ self.inline.append(tp)
156
+ return "dict"
157
+
158
+ if isinstance(tp, type):
159
+ return tp.__name__
160
+
161
+ return str(tp)
162
+
163
+
164
+ def _strip_optional(tp: t.Any) -> t.Any:
165
+ """Remove `None` from a union type."""
166
+ if t.get_origin(tp) in UNION_TYPES:
167
+ args = [a for a in t.get_args(tp) if a is not type(None)]
168
+ if len(args) == 1:
169
+ return args[0]
170
+ return t.Union[tuple(args)] # noqa: UP007
171
+ return tp
172
+
173
+
174
+ def _keyed_by(tp: t.Any) -> t.Any:
175
+ if t.get_origin(tp) is t.Annotated:
176
+ for meta in t.get_args(tp)[1:]:
177
+ if is_keyed_by(meta):
178
+ return meta
179
+ return None
180
+
181
+
182
+ def _get_default(field: msgspec.structs.FieldInfo) -> t.Any:
183
+ if field.default is not msgspec.NODEFAULT:
184
+ return field.default
185
+ if field.default_factory is not msgspec.NODEFAULT:
186
+ return field.default_factory()
187
+ return msgspec.NODEFAULT
188
+
189
+
190
+ def iter_struct_lines(
191
+ cls: type, indent: int = 0, seen: tuple[type, ...] = ()
192
+ ) -> t.Generator[str, None, None]:
193
+ prefix = " " * indent
194
+ arg_prefix = prefix + " "
195
+ seen = seen + (cls,)
196
+
197
+ config = cls.__struct_config__
198
+ extra = "forbidden" if config.forbid_unknown_fields else "allowed"
199
+ yield f"{prefix}*extra keys: {extra}*"
200
+ yield ""
201
+
202
+ fields = msgspec.structs.fields(cls)
203
+ encode_names = {f.name: f.encode_name for f in fields}
204
+
205
+ for group in getattr(cls, "exclusive", None) or ():
206
+ names = ", ".join(f"``{encode_names.get(f, f)}``" for f in group)
207
+ yield f"{prefix}**mutually exclusive**: {names}"
208
+ yield ""
209
+
210
+ for field in fields:
211
+ tp = field.type
212
+ default = _get_default(field)
213
+
214
+ # Don't display `None` as a valid type if it's just the default.
215
+ if default is None:
216
+ tp = _strip_optional(tp)
217
+
218
+ fmt = TypeFormatter()
219
+ if keyed_by := _keyed_by(tp):
220
+ type_str = fmt(keyed_by.wrapped_type)
221
+ else:
222
+ type_str = fmt(tp)
223
+
224
+ status = "required" if field.required else "optional"
225
+ yield f"{prefix}``{field.encode_name}`` ({status})"
226
+ yield f"{arg_prefix}**type**: {type_str}"
227
+
228
+ if keyed_by:
229
+ fields_str = ", ".join(f"``{f[3:]}``" for f in sorted(keyed_by.fields))
230
+ yield ""
231
+ yield f"{arg_prefix}**optionally keyed by**: {fields_str}"
232
+
233
+ if default not in (msgspec.NODEFAULT, None):
234
+ yield ""
235
+ yield f"{arg_prefix}**default**: {_literal(default)}"
236
+
237
+ if desc := field_description(cls, field.name):
238
+ yield ""
239
+ for line in desc:
240
+ yield f"{arg_prefix}{line}" if line else ""
241
+
242
+ yield ""
243
+
244
+ for sub in fmt.inline:
245
+ if sub in seen:
246
+ continue
247
+ yield from iter_struct_lines(sub, indent + 3, seen)
248
+
249
+ yield ""
250
+
251
+
252
+ # Names of fields belonging to schema classes in the module currently being
253
+ # documented. In Sphinx 9+, slotted members (like Struct fields) are passed to
254
+ # `autodoc-skip-member` as a sentinel without any reference to the class they
255
+ # belong to, and only after every class in the module has been processed.
256
+ _module_fields: set[str] = set()
257
+
258
+
259
+ def process_docstring(app, what, name, obj, options, lines):
260
+ if what == "module":
261
+ _module_fields.clear()
262
+
263
+ if what not in ("class", "data", "attribute") or not is_struct(obj):
264
+ return
265
+
266
+ if what == "class":
267
+ _module_fields.update(obj.__struct_fields__)
268
+
269
+ # Aliases of documented classes (e.g. `CHUNK_SCHEMA = ChunkSchema`) just
270
+ # link to the class.
271
+ if name.rsplit(".", 1)[-1] != obj.__name__ and is_canonical(obj):
272
+ return
273
+
274
+ # Don't inherit the docstring of the `Schema` base class.
275
+ if not obj.__dict__.get("__doc__"):
276
+ lines.clear()
277
+ elif lines and lines[-1]:
278
+ lines.append("")
279
+
280
+ lines.extend(iter_struct_lines(obj))
281
+
282
+
283
+ def process_signature(app, what, name, obj, options, signature, return_annotation):
284
+ # Hide the generated `__init__` signature, as schemas are never
285
+ # instantiated directly.
286
+ if what == "class" and is_struct(obj):
287
+ return "", return_annotation
288
+ return None
289
+
290
+
291
+ def skip_member(app, what, name, obj, skip, options):
292
+ # Fields are rendered as part of the class docstring.
293
+ if what != "class":
294
+ return None
295
+
296
+ # Legacy class based autodoc passes the slot descriptor.
297
+ objclass = getattr(obj, "__objclass__", None)
298
+ if isinstance(obj, types.MemberDescriptorType) and is_struct(objclass):
299
+ return name in objclass.__struct_fields__ or None # type: ignore[union-attr]
300
+
301
+ if any(obj is s for s in SLOTS_SENTINELS) and name in _module_fields:
302
+ return True
303
+ return None
@@ -1,7 +1,7 @@
1
1
  ### Project
2
2
  [project]
3
3
  name = "taskcluster-taskgraph"
4
- version = "24.8.0"
4
+ version = "25.0.0"
5
5
  description = "Build taskcluster taskgraphs"
6
6
  readme = "README.rst"
7
7
  authors = [
@@ -11,7 +11,6 @@ classifiers = [
11
11
  "Development Status :: 5 - Production/Stable",
12
12
  "Environment :: Console",
13
13
  "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
14
- "Programming Language :: Python :: 3.9",
15
14
  "Programming Language :: Python :: 3.10",
16
15
  "Programming Language :: Python :: 3.11",
17
16
  "Programming Language :: Python :: 3.12",
@@ -19,7 +18,7 @@ classifiers = [
19
18
  "Programming Language :: Python :: 3.14",
20
19
  "Topic :: Software Development",
21
20
  ]
22
- requires-python = ">=3.9"
21
+ requires-python = ">=3.10"
23
22
  dependencies = [
24
23
  "appdirs>=1.4",
25
24
  "cookiecutter~=2.1",
@@ -50,7 +49,7 @@ dev = [
50
49
  "sphinx-autobuild>=2024.04.16",
51
50
  "sphinx-argparse>=0.4.0",
52
51
  "sphinx-book-theme >=1.1.4",
53
- "sphinx-taskgraph>=0.1.0",
52
+ "sphinx-taskgraph>=0.2.0",
54
53
  "sphinxcontrib-mermaid>=1.0.0",
55
54
  "vermin>=1.8.0",
56
55
  "zstandard>=0.25.0",