File: docs.py

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (50 lines) | stat: -rw-r--r-- 1,517 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# 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/.

import logging
from functools import cache
from pathlib import Path

from taskgraph.optimize.base import OptimizationStrategy, register_strategy
from taskgraph.util.yaml import load_yaml

from gecko_taskgraph import GECKO

logger = logging.getLogger(__name__)


@register_strategy("skip-unless-sphinx-js")
class SkipUnlessSphinxJs(OptimizationStrategy):
    """
    Optimization strategy for tasks using Sphinx JS.

    This strategy checks if any changed files match the js_source_paths
    configured in docs/config.yml.
    """

    @classmethod
    @cache
    def _get_js_source_paths(cls):
        doc_config_file = Path(GECKO) / "docs" / "config.yml"

        try:
            return load_yaml(doc_config_file)["js_source_paths"]
        except Exception as e:
            logger.warning(f"Failed to load docs/config.yml: {e}")
            return []

    def should_remove_task(self, task, params, _):
        files_changed = params.get("files_changed", [])
        if not files_changed:
            return True

        js_source_paths = self._get_js_source_paths()
        if not js_source_paths:
            return True

        for file_path in files_changed:
            for js_path in js_source_paths:
                if file_path.startswith(js_path):
                    return False
        return True