mkdocstrings-github 0.4.1__py3-none-any.whl → 0.4.3__py3-none-any.whl

{mkdocstrings_github-0.4.1.dist-info → mkdocstrings_github-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.4.1
+Version: 0.4.3
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -23,6 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: <3.15,>=3.10
 Requires-Dist: gitpython~=3.1.45
 Requires-Dist: mkdocstrings~=0.29
+Requires-Dist: packaging~=25.0
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 

{mkdocstrings_github-0.4.1.dist-info → mkdocstrings_github-0.4.3.dist-info}/RECORD

@@ -1,17 +1,17 @@
 mkdocstrings_handlers/github/__init__.py,sha256=0WdFUIq4Xu2ZFtlZNIYCQSoqcx3Ot9Wv41_X_dwbFww,248
 mkdocstrings_handlers/github/config.py,sha256=pSjA6gU-kC_mXQqNIIGOYEOhtX5VzZDT0H1hRFlGaj8,6089
-mkdocstrings_handlers/github/handler.py,sha256=5-vc49Te_BIW7oX8KfuNrbQOWpM0xBMLugP1z1Hm4E8,7953
+mkdocstrings_handlers/github/handler.py,sha256=QJbZjRbllUuGs5rY6SLwaII6hsPQnioa_OmauWGL-lU,8495
 mkdocstrings_handlers/github/objects.py,sha256=JDkY7mg_LGlIEwZHP2wSd8ZkB6RVtRsu_JEpwV-PikQ,7069
 mkdocstrings_handlers/github/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/github/rendering.py,sha256=tJeAsSaijqSC2IkxYsIXq7d0lR2A3aB5PRUcFFTFpVU,2705
+mkdocstrings_handlers/github/rendering.py,sha256=6xcE2WwyTRW_38g7Ek55hlm53EsFFqueazFw12__DyA,2820
 mkdocstrings_handlers/github/templates/material/action.html.jinja,sha256=87NCgz-zY16rU7tEmJETJ0gLwdzxoBrqLtp9vsVCsiw,2435
 mkdocstrings_handlers/github/templates/material/heading.html.jinja,sha256=wnvZpNED8Dhb935qnddeDExXN-MIUz8frRRfgq-A9VA,1396
 mkdocstrings_handlers/github/templates/material/inputs.html.jinja,sha256=CIcw3OBQdCP4e5A4srLu1v3xoOjsedIw1Zh3qxtG0-A,3482
 mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=jlzVF93q5AyJfOiSl3_1VBVL3c6rjmEcS81s3sri5Gg,2670
 mkdocstrings_handlers/github/templates/material/secrets.html.jinja,sha256=1lMJoxjjeiqetVu0mdLKmZ1faYRReeyjiYvYTZESots,2881
 mkdocstrings_handlers/github/templates/material/style.css,sha256=R2hh1RfHwJ6XNT4YQl_txNkNXcPBZJMCBZn5kQEMQ6M,962
-mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=E1VUi2w7_NDkpS9VNrWRV52hhyhQvnKUrjPbV_j0Qcg,3312
-mkdocstrings_github-0.4.1.dist-info/METADATA,sha256=G-g63IhkT-QCiHSrVFuXZRYr_juCVpy9MIfVAOoJCQc,3309
-mkdocstrings_github-0.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_github-0.4.1.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
-mkdocstrings_github-0.4.1.dist-info/RECORD,,
+mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=89hEu1dagyqEV_40iTeCR4UKvdI4HlIJaUAebqugxNM,3400
+mkdocstrings_github-0.4.3.dist-info/METADATA,sha256=0G1SP3Qs5hbC6rPz32iZ1uJT-jnaFq6X7pWNUfeHLnc,3340
+mkdocstrings_github-0.4.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_github-0.4.3.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
+mkdocstrings_github-0.4.3.dist-info/RECORD,,

mkdocstrings_handlers/github/handler.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import os
 import re
-import sys
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, ClassVar, Mapping
 
@@ -16,6 +15,7 @@ from mkdocstrings import (
     HandlerOptions,
     get_logger,
 )
+from packaging.version import InvalidVersion, Version
 
 from mkdocstrings_handlers.github import rendering
 from mkdocstrings_handlers.github.config import GitHubConfig, GitHubOptions
@@ -67,75 +67,89 @@ class GitHubHandler(BaseHandler):
         self.config = config
         self.repo = repo
         self.global_options = config.options.__dict__
-        self.workflows: dict[Path, Workflow] = {}
-        self.actions: dict[Path, Action] = {}
         self.major: str = ""
         self.semver: str = ""
 
-        # Only run GitHub releases code if required and not in testing
-        not_testing = "pytest" not in sys.modules
-        no_custom_tags = (
-            rendering.ENV_MAJOR_TAG not in os.environ or rendering.ENV_SEMVER_TAG not in os.environ
-        )
-        if not_testing and no_custom_tags:
+        # Determine owner and repo name
+        if not self.config.repo:
+            self.get_repo()
+
+        if rendering.ENV_MAJOR_TAG not in os.environ or rendering.ENV_SEMVER_TAG not in os.environ:
             self.get_releases()
 
-        # Glob all workflow YAML files using pathlib
-        working_tree_dir = Path(repo.working_tree_dir)
-        workflows_dir = working_tree_dir / ".github" / "workflows"
-        for workflow_file in list(workflows_dir.glob("*.yml")) + list(workflows_dir.glob("*.yaml")):
-            id = str(workflow_file.relative_to(working_tree_dir))
-            workflow = Workflow.from_file(workflow_file, id)
-            if workflow is not None:
-                self.workflows[workflow_file] = workflow
-
-        # Glob all action.yaml and action.yml files, skipping .git folder entirely using pathlib
-        def find_action_files(base: Path):
-            for entry in base.iterdir():
-                if entry.is_dir():
-                    if entry.name == ".git":
-                        continue
-                    yield from find_action_files(entry)
-                elif entry.is_file() and entry.name in ("action.yaml", "action.yml"):
-                    yield entry
-
-        for action_file in find_action_files(working_tree_dir):
-            id = str(action_file.relative_to(working_tree_dir).parent)
-            action = Action.from_file(action_file, id)
-            if action is not None:
-                self.actions[action_file] = action
+    def get_repo(self) -> None:
+        # Get repo from environment variable or git remotes.
+        if os.environ.get("GITHUB_ACTIONS") == "true" and (
+            repo := os.environ.get("GITHUB_REPOSITORY")
+        ):
+            self.config.repo = repo
+        else:
+            # Try each remote to find a valid GitHub owner/repo
+            owner = None
+            repo_name = None
+            for remote in self.repo.remotes:
+                for url in remote.urls:
+                    match = re.search(
+                        r"(?P<host>[\w\.-]+)[/:](?P<owner>[^/]+)/(?P<repo>[^/.]+?)(?:\.git)?$",
+                        url,
+                    )
+                    if match:
+                        owner = match.group("owner")
+                        repo_name = match.group("repo")
+                        break
+                if owner and repo_name:
+                    break
+            if not (owner and repo_name):
+                raise PluginError(
+                    f"Could not determine GitHub repository owner/name from config.repo='{self.config.repo}' or any git remote URL."
+                )
+            self.config.repo = f"{owner}/{repo_name}"
 
     def get_releases(self) -> None:
-        # Get all tags from the local git repository
+        # Get all tags from the local git repository.
         try:
-            tags = sorted([tag.name for tag in self.repo.tags], reverse=True)
+            tags = [tag.name for tag in self.repo.tags]
         except Exception as e:
             _logger.warning(f"Could not get git tags from repository: {e}")
             return
 
-        # Find matching tags
+        # Separate semver, major, and other tags
+        semver_tags = []
+        major_tags = []
+        other_tags = []
         for tag in tags:
-            if not self.semver and SEMVER_PATTERN.match(tag):
-                _logger.info(f"Using git tag '{tag}' for semver.")
-                self.semver = tag
-            if not self.major and MAJOR_PATTERN.match(tag):
-                _logger.info(f"Using git tag '{tag}' for major.")
-                self.major = tag
-            if self.semver and self.major:
-                break
-
-        if not self.semver or not self.major:
-            if not self.semver and not self.major:
-                messages = ("'vX.X.X' and 'vX'", "'semver and major'")
-            elif not self.semver:
-                messages = ("'vX.X.X'", "'semver'")
-            else:  # not self.major
-                messages = ("'vX'", "'major'")
-            _logger.warning(
-                f"Could not find suitable git tags in repository. "
-                f"Make sure there are tags matching {messages[0]}, "
-                f"if you wish to use option signature_version {messages[1]}.",
-            )
+            if SEMVER_PATTERN.match(tag):
+                semver_tags.append(tag)
+            elif MAJOR_PATTERN.match(tag):
+                major_tags.append(tag)
+            else:
+                other_tags.append(tag)
+
+        # Sort tags using packaging.version.Version
+        def version_key(tag):
+            try:
+                return Version(tag.lstrip("v"))
+            except InvalidVersion:
+                return Version("0.0.0")
+
+        semver_tags_sorted = sorted(semver_tags, key=version_key, reverse=True)
+        major_tags_sorted = sorted(major_tags, key=version_key, reverse=True)
+        other_tags_sorted = sorted(other_tags, reverse=True)
+
+        if semver_tags_sorted:
+            self.semver = semver_tags_sorted[0]
+            _logger.info(f"Using git tag '{self.semver}' for semver.")
+        else:
+            _logger.warning("No semver tags found in repository.")
+
+        if major_tags_sorted:
+            self.major = major_tags_sorted[0]
+            _logger.info(f"Using git tag '{self.major}' for major.")
+        else:
+            _logger.warning("No major tags found in repository.")
+
+        if other_tags_sorted:
+            _logger.debug(f"Other git tags found: {', '.join(other_tags_sorted)}")
 
     def get_options(self, local_options: Mapping[str, Any]) -> HandlerOptions:
         """Get combined default, global and local options.
@@ -166,16 +180,26 @@ class GitHubHandler(BaseHandler):
         self.env.globals["major_tag"] = self.major
         self.env.globals["git_repo"] = self.repo
 
-    def collect(self, identifier: str, options: GitHubOptions) -> Workflow | Action:
+    def collect(self, identifier: str, options: GitHubOptions) -> Workflow | Action | None:
         path = Path(self.repo.working_tree_dir) / identifier
-        if path in self.workflows:
-            return self.workflows[path]
-        elif (action_path := path / "action.yml") in self.actions:
-            return self.actions[action_path]
-        elif (action_path := path / "action.yaml") in self.actions:
-            return self.actions[action_path]
+
+        if path.suffix in (".yml", ".yaml"):
+            if not path.is_file():
+                raise CollectionError(f"Identifier '{identifier}' is not a valid workflow file.")
+            data = Workflow.from_file(path, id=identifier)
+        elif not path.is_dir():
+            raise CollectionError(
+                f"Identifier '{identifier}' is not a valid workflow file or action directory."
+            )
+        elif (action_path := path / "action.yml").is_file():
+            data = Action.from_file(action_path, id=identifier)
+        elif (action_path := path / "action.yaml").is_file():
+            data = Action.from_file(action_path, id=identifier)
         else:
-            raise CollectionError(f"Identifier '{identifier}' not found as a workflow or action.")
+            raise CollectionError(
+                f"Identifier '{identifier}' is not a valid workflow file or action directory."
+            )
+        return data
 
     def render(self, data: Workflow | Action, options: GitHubOptions) -> str:
         """Render a template using provided data and configuration options.

mkdocstrings_handlers/github/rendering.py

@@ -23,8 +23,11 @@ def format_action_signature(context: Context, id: str, repo: str, options: GitHu
     match options.signature_version:
         case "ref":
             try:
-                repo: Repo = context.environment.globals["git_repo"]
-                version = repo.head.ref.name
+                git_repo = context.environment.globals["git_repo"]
+                if isinstance(git_repo, Repo):
+                    version = git_repo.head.ref.name
+                else:
+                    version = "unknown"
             except Exception:
                 version = "unknown"
         case "major":

mkdocstrings_handlers/github/templates/material/workflow.html.jinja

@@ -24,25 +24,29 @@ Context:
 
   {% block signature scoped %}
     {% if options.show_signature %}
-      {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
-        {% filter highlight(language="yaml", inline=False, linenums=False) %}
-          uses: {{ signature }}
-          {% if options.signature_show_permissions and data.permissions %}
-          permissions:
-            {% for scope, level in data.permissions | items %}
-            {{ scope }}: {{ level.label }}
-            {% endfor %}
-          {% endif %}
-          with:
-            {%+ for input in inputs %}{{ input.name }}: ''{% endfor +%}
-          {% if options.signature_show_secrets %}
-            {% with secrets = data.secrets | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
-          secrets:
-            {%+ for secret in secrets %}{{ secret.name }}: ''{% endfor +%}
-            {% endwith %}
-          {% endif %}
-        {% endfilter %}
-      {% endwith %}
+      {% filter highlight(language="yaml", inline=False, linenums=False) %}
+        uses: {{ signature }}
+        {% if options.signature_show_permissions and data.permissions|length > 0 %}
+        permissions:
+          {% for scope, level in data.permissions | items %}
+          {{ scope }}: {{ level.label }}
+          {% endfor %}
+        {% endif %}
+        {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
+        {% if inputs|length > 0 %}
+        with:
+          {%+ for input in inputs %}{{ input.name }}: ''{% endfor +%}
+        {% endif %}
+        {% endwith %}
+        {% if options.signature_show_secrets %}
+        {% with secrets = data.secrets | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
+        {% if secrets|length > 0 %}
+        secrets:
+          {%+ for secret in secrets %}{{ secret.name }}: ''{% endfor +%}
+        {% endif %}
+        {% endwith %}
+        {% endif %}
+      {% endfilter %}
     {% endif %}
   {% endblock signature %}