taskcluster-taskgraph 24.0.0__tar.gz → 24.1.1__tar.gz

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/.github/workflows/codeql-analysis.yml

@@ -39,10 +39,10 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # v6.0.3
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e  # v4.36.2
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -55,7 +55,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@8aad20d150bbac5944a9f9d289da16a4b0d87c1e  # v4.36.2
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -67,4 +67,4 @@ jobs:
       #   echo "Run, Build Application using script"
       #   ./location_of_script_within_repo/buildscript.sh
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e  # v4.36.2

taskcluster_taskgraph-24.1.1/.github/workflows/codspeed.yml

@@ -0,0 +1,31 @@
+---
+name: CodSpeed
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read  # required for actions/checkout
+      id-token: write  # required for OIDC authentication with CodSpeed
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # v6.0.3
+      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39  # v8.2.0
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: uv sync
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@9d332c4d90b43981c3e55ae8e38e68709996240f  # v4.17.0
+        with:
+          mode: simulation
+          run: uv run pytest test/ --codspeed

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/.github/workflows/pypi-publish.yml

@@ -12,8 +12,8 @@ jobs:
       id-token: write
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # v6.0.3
+      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
         with:
           python-version: '3.11'
           cache: 'pip'
@@ -21,8 +21,14 @@ jobs:
         run: |
           pip install build
           python -m build
+      # NOTE: We deliberately pin this action to a commit SHA rather than the
+      #       mutable `@release/v1` ref that PyPA recommends. The pin stops the
+      #       action from being swapped out from under a workflow that holds PyPI
+      #       publish (OIDC) rights; the cost is losing automatic upstream patches.
+      #       Renovate offsets that by bumping the pinned SHA (tracked via the
+      #       trailing `# vX.Y.Z` comment), so merge those bump PRs promptly.
       - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
   pypi-publish-pytest-taskgraph:
     name: upload release to PyPI
     if: startsWith(github.ref, 'refs/tags/pytest-taskgraph')
@@ -32,8 +38,8 @@ jobs:
       id-token: write
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # v6.0.3
+      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
         with:
           python-version: '3.11'
           cache: 'pip'
@@ -43,7 +49,7 @@ jobs:
           pip install build
           python -m build
       - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
         with:
           packages-dir: packages/pytest-taskgraph/dist
   pypi-publish-sphinx-taskgraph:
@@ -55,8 +61,8 @@ jobs:
       id-token: write
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # v6.0.3
+      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
         with:
           python-version: '3.11'
           cache: 'pip'
@@ -66,6 +72,6 @@ jobs:
           pip install build
           python -m build
       - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
         with:
           packages-dir: packages/sphinx-taskgraph/dist

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/.gitignore

@@ -12,6 +12,7 @@ __pycache__/
 *.py[cod]
 *.egg-info/
 
+.codspeed/
 .pytest_cache/
 .python-version
 .ruff_cache/

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [24.1.1] - 2026-06-11
+
+### Fixed
+
+- Use proper `comm` parameters in Git repos as well
+
+## [24.1.0] - 2026-06-04
+
+### Added
+
+- support for custom context in task-context (#971)
+
 ## [24.0.0] - 2026-06-03
 
 ### Changed

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: taskcluster-taskgraph
-Version: 24.0.0
+Version: 24.1.1
 Summary: Build taskcluster taskgraphs
 Project-URL: Repository, https://github.com/taskcluster/taskgraph
 Project-URL: Issues, https://github.com/taskcluster/taskgraph/issues
@@ -44,6 +44,10 @@ Description-Content-Type: text/x-rst
    :target: https://codecov.io/gh/taskcluster/taskgraph
    :alt: Code Coverage
 
+.. image:: https://img.shields.io/endpoint?url=https://codspeed.io/badge.json
+   :target: https://codspeed.io/taskcluster/taskgraph?utm_source=badge
+   :alt: CodSpeed Performance
+
 .. image:: https://badge.fury.io/py/taskcluster-taskgraph.svg
    :target: https://badge.fury.io/py/taskcluster-taskgraph
    :alt: Pypi Version

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/README.rst

@@ -7,6 +7,10 @@
    :target: https://codecov.io/gh/taskcluster/taskgraph
    :alt: Code Coverage
 
+.. image:: https://img.shields.io/endpoint?url=https://codspeed.io/badge.json
+   :target: https://codspeed.io/taskcluster/taskgraph?utm_source=badge
+   :alt: CodSpeed Performance
+
 .. image:: https://badge.fury.io/py/taskcluster-taskgraph.svg
    :target: https://badge.fury.io/py/taskcluster-taskgraph
    :alt: Pypi Version

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/docs/reference/transforms/task_context.rst

@@ -98,35 +98,6 @@ with the this ``kind``:
 ...the description will bring in the value ``foo`` from the parameters if
 present, or ``default`` otherwise.
 
-from-file
-~~~~~~~~~
-
-Context may also be provided from a defined yaml file. The provided file
-should usually only contain top level keys and values (eg: nested objects
-will not be interpolated - they will be substituted as text representations
-of the object).
-
-For example, with this kind definition:
-
-.. code-block:: yaml
-
-   tasks:
-     build:
-       description: my description {foo}
-       task-context:
-         from-file: some_file.yaml
-         substitution-fields:
-           - description
-
-And this in ``some_file.yaml``:
-
-.. code-block:: yaml
-
-   foo: from a file
-
-...description will end up with "my description from a file".
-
-
 from-object
 ~~~~~~~~~~~
 
@@ -158,6 +129,86 @@ For example:
 This will give build1 and build2 descriptions with their ``extra_desc``
 included while allowing them to share the rest of their task definition.
 
+from-custom
+~~~~~~~~~~~
+
+Context may be provided by custom providers, which must be registered prior
+to this transform being run. This allows the creation of context that is
+derived from parameters, code constants, or anything else accessible to
+taskgraph.
+
+For example, you may have a custom context handler set-up in
+``taskcluster/my_taskgraph/custom_context.py``:
+
+.. code-block:: python
+
+   NON_PRODUCTION_BRANCHES = ["maple", "pine"]
+
+   @custom_context("release-level")
+   def release_level_context(config, task):
+       # Despite being level 3, some branches are not truly considered "production"
+       # in the sense of creating releases that ship to users.
+       if config.params["level"] == "1" or config.params["project"] in NON_PRODUCTION_BRANCHES:
+           return "staging"
+       return "production"
+
+
+In your ``register`` function you will need to ensure you import this module.
+Eg: ``taskcluster/my_taskgraph/__init__.py``:
+
+.. code-block:: python
+
+   def register(graph_config):
+       from my_taskgraph import custom_contexts  # trigger custom task-context registration
+
+
+Now you can use ``release-level`` as context in a kind:
+
+.. code-block:: yaml
+
+   task-defaults:
+     task-context:
+       from-custom:
+         - release-level
+       substitution-fields:
+         - scopes
+
+     scopes:
+       by-release-level:
+         staging:
+           - secrets:get:staging_creds
+         production:
+           - secrets:get:production_creds
+
+
+from-file
+~~~~~~~~~
+
+Context may also be provided from a defined yaml file. The provided file
+should usually only contain top level keys and values (eg: nested objects
+will not be interpolated - they will be substituted as text representations
+of the object).
+
+For example, with this kind definition:
+
+.. code-block:: yaml
+
+   tasks:
+     build:
+       description: my description {foo}
+       task-context:
+         from-file: some_file.yaml
+         substitution-fields:
+           - description
+
+And this in ``some_file.yaml``:
+
+.. code-block:: yaml
+
+   foo: from a file
+
+...description will end up with "my description from a file".
+
 Implicit Context
 ~~~~~~~~~~~~~~~~
 
@@ -185,7 +236,7 @@ Keys will be resolved on ``substitution-fields`` first, then substitution
 will be performed on the resolved value.
 
 If the same key is found in multiple places the order of precedence is as
-follows: ``from-parameters``, ``from-object`` keys, ``from-file`` and finally
+follows: ``from-parameters``, ``from-object`` keys, ``from-custom`` providers, ``from-file`` and finally
 implicit context.
 
 That is to say: parameters will always override anything else.

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/pyproject.toml

@@ -1,7 +1,7 @@
 ### Project
 [project]
 name = "taskcluster-taskgraph"
-version = "24.0.0"
+version = "24.1.1"
 description = "Build taskcluster taskgraphs"
 readme = "README.rst"
 authors = [
@@ -42,6 +42,7 @@ dev = [
   "pre-commit>=4.3.0",
   "pyright>=1.1.406",
   "pytest>=8.4.2",
+  "pytest-codspeed>=3.2.0",
   "pytest-mock>=3.15.1",
   "pytest-taskgraph>=0.2.0",
   "responses>=0.25.8",

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/src/taskgraph/parameters.py

@@ -291,30 +291,33 @@ class Parameters(ReadOnlyDict):
 
         :return str: The URL displaying the given path.
         """
+        if "comm/" in path:
+            path = path.split("comm/")[1]
+            repo_key = "comm_head_repository"
+            rev_key = "comm_head_rev"
+        else:
+            repo_key = "head_repository"
+            rev_key = "head_rev"
+
         if self["repository_type"] == "hg":
-            if "comm/" in path:
-                path = path.split("comm/")[1]
-                repo = self["comm_head_repository"]
-                rev = self["comm_head_rev"]
-            else:
-                repo = self["head_repository"]
-                rev = self["head_rev"]
+            repo = self[repo_key]
+            rev = self[rev_key]
             endpoint = "file" if pretty else "raw-file"
             return f"{repo}/{endpoint}/{rev}/{path}"
         elif self["repository_type"] == "git":
             # For getting the file URL for git repositories, we only support a Github HTTPS remote
-            repo = self["head_repository"]
+            repo = self[repo_key]
             if repo.startswith("https://github.com/"):
                 if repo.endswith("/"):
                     repo = repo[:-1]
 
-                rev = self["head_rev"]
+                rev = self[rev_key]
                 endpoint = "blob" if pretty else "raw"
                 return f"{repo}/{endpoint}/{rev}/{path}"
             elif repo.startswith("git@github.com:"):
                 if repo.endswith(".git"):
                     repo = repo[:-4]
-                rev = self["head_rev"]
+                rev = self[rev_key]
                 endpoint = "blob" if pretty else "raw"
                 return "{}/{}/{}/{}".format(
                     repo.replace("git@github.com:", "https://github.com/"),

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/src/taskgraph/transforms/task_context.py

@@ -2,6 +2,7 @@ from typing import Optional, Union
 
 from taskgraph.transforms.base import TransformSequence
 from taskgraph.util.schema import Schema, resolve_keyed_by
+from taskgraph.util.task_context import CUSTOM_CONTEXT_MAP
 from taskgraph.util.templates import deep_get, substitute_task_fields
 from taskgraph.util.yaml import load_yaml
 
@@ -28,6 +29,12 @@ class TaskContextConfig(Schema):
     from_file: Optional[str] = None
     # Key/value pairs to be used as task context
     from_object: Optional[object] = None
+    # Retrieve task context values from registered custom providers. Each
+    # entry is the name of a provider registered via
+    # ``taskgraph.util.task_context.custom_context``. Providers are called
+    # with the ``TransformConfig`` and the task being rendered, and must
+    # return a dict of key/value pairs to add to the context.
+    from_custom: Optional[list[str]] = None
     resolve_keyed_by_options: Optional[ResolveKeyedByConfigOptions] = None
 
 
@@ -51,6 +58,7 @@ class TaskContextSchema(Schema, forbid_unknown_fields=False, kw_only=True):
     # is as follows:
     #   - Parameters
     #   - `from-object` keys
+    #   - Custom providers (`from-custom`)
     #   - File
     #
     # That is to say: parameters will always override anything else.
@@ -89,10 +97,18 @@ def render_task(config, tasks):
         if from_file:
             file_context = load_yaml(from_file)
 
+        custom_context = {}
+        for name in sub_config.pop("from-custom", None) or []:
+            if name not in CUSTOM_CONTEXT_MAP:
+                raise ValueError(f"no provider found for custom context '{name}'")
+
+            custom_context.update(CUSTOM_CONTEXT_MAP[name](config, task))
+
         fields = sub_config.pop("substitution-fields")
 
         subs = {}
         subs.update(file_context)
+        subs.update(custom_context)
         # We've popped away the configuration; everything left in `sub_config` is
         # substitution key/value pairs.
         subs.update(sub_config.pop("from-object", {}))

taskcluster_taskgraph-24.1.1/src/taskgraph/util/task_context.py

@@ -0,0 +1,20 @@
+# 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/.
+
+# Define a collection of custom task-context providers.
+# Note: this is stored here instead of where it is used in the
+# `task_context` transform to give consumers a chance to register their own
+# providers before the `task_context` schema is created.
+CUSTOM_CONTEXT_MAP = {}
+
+
+def custom_context(name):
+    def wrapper(func):
+        assert name not in CUSTOM_CONTEXT_MAP, (
+            f"duplicate custom_context function name {name} ({func} and {CUSTOM_CONTEXT_MAP[name]})"
+        )
+        CUSTOM_CONTEXT_MAP[name] = func
+        return func
+
+    return wrapper

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/taskcluster/docker/index-task/yarn.lock

@@ -63,9 +63,9 @@
     "@types/node" "*"
 
 "@types/node@*":
-  version "25.9.1"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-25.9.1.tgz#3bda556db500ae4319c08e7fc9ab94f19013ba0b"
-  integrity sha512-xfrlY7UD5rMJk3ZVJP8BNzS28J36YJg+xp+LPXV1TdWxr8uMH5A860QNxYDGQe/ylDSgjxE52Q9VnO7p75tJxg==
+  version "25.9.2"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-25.9.2.tgz#fc8958e757994b71fee516f9634bdb03d1b19e9f"
+  integrity sha512-G05zqtJhcDLb8uslf5EjCxXg9G1KQxiV8OS0R26IC//Eoyitzqe8z37I7cqvnZlrlSfgocQRfSn/AHBZJJFyGw==
   dependencies:
     undici-types ">=7.24.0 <7.24.7"
 

{taskcluster_taskgraph-24.0.0 → taskcluster_taskgraph-24.1.1}/test/data/task_context.yml

@@ -1,4 +1,5 @@
 file: file
+file_and_custom: file_and_custom
 direct_and_file: shouldn't be used
 file_and_param: shouldn't be used
 direct_file_and_param: shouldn't be used