mkdocstrings-github 0.4.1__tar.gz → 0.4.3__tar.gz

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/.github/workflows/docs.yaml

@@ -59,6 +59,8 @@ jobs:
   
       - name: Build documentation with mike
         shell: bash
+        env:
+          VERSION: ${{ inputs.version }}
         run: |
           if [[ $VERSION =~ ^v([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
             VERSION="v${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.*"
@@ -68,7 +70,7 @@ jobs:
             --update-aliases \
             --branch gh-pages \
             --alias-type symlink \
-            "${{ inputs.version }}" "${{ inputs.alias }}"
+            "${VERSION}" "${{ inputs.alias }}"
       
       - name: Set default alias for mike 
         if: ${{ fromJson(inputs.set-default) }}

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/.pre-commit-config.yaml

@@ -29,8 +29,3 @@ repos:
         entry: uv run ruff format --force-exclude
         language: python
         types_or: [python, pyi, jupyter]
-      - id: ty
-        name: ty check
-        entry: uv run ty check . --ignore unresolved-import
-        language: python
-        types_or: [python, pyi, jupyter]

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/PKG-INFO

@@ -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 → mkdocstrings_github-0.4.3}/mkdocs.yml

@@ -120,6 +120,7 @@ plugins:
     default_handler: github
     handlers:
       github:
+        repo: owner/repository
         options:
           show_toc_entry: false
           heading_level: 3

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.4.1"
+version = "0.4.3"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -29,12 +29,13 @@ classifiers = [
 dependencies = [
     "gitpython~=3.1.45",
     "mkdocstrings~=0.29",
+    "packaging~=25.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
 
 [dependency-groups]
 dev = [
-    "ty~=0.0.1a19",
+    "ty~=0.0.1a22",
     "ruff~=0.14.0",
     "prek>=0.2.1",
     "pydantic~=2.12",
@@ -129,5 +130,6 @@ pythonpath = [
     "test"
 ]
 markers = [
-    "without_handler"
+    "without_repo",
+    "github_actions"
 ]

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/src/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_github-0.4.1 → mkdocstrings_github-0.4.3}/src/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_github-0.4.1 → mkdocstrings_github-0.4.3}/src/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 %}
 

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/test/conftest.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import os
 from collections.abc import Iterator
 from typing import TYPE_CHECKING
 
@@ -69,7 +70,9 @@ def ext_markdown(mkdocs_conf: MkDocsConfig) -> Markdown:
 
 
 @pytest.fixture
-def handler(plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> Iterator[GitHubHandler]:
+def handler(
+    plugin: MkdocstringsPlugin, ext_markdown: Markdown, request: pytest.FixtureRequest
+) -> Iterator[GitHubHandler]:
     """Return a handler instance.
 
     Parameters:
@@ -78,8 +81,24 @@ def handler(plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> Iterator[GitH
     Returns:
         A handler instance.
     """
-    handler = helpers.handler(plugin, ext_markdown)
-    yield handler
+    marker = request.node.get_closest_marker("github_actions")
+    if marker is not None:
+        os.environ["GITHUB_ACTIONS"] = "true"
+        os.environ["GITHUB_REPOSITORY"] = "watermarkhu/mkdocstrings-github"
+        try:
+            handler = helpers.handler(plugin, ext_markdown)
+            yield handler
+        finally:
+            os.environ.pop("GITHUB_REPOSITORY", None)
+            os.environ.pop("GITHUB_ACTIONS", None)
+    else:
+        github_repo = os.environ.pop("GITHUB_REPOSITORY", None)
+        try:
+            handler = helpers.handler(plugin, ext_markdown)
+            yield handler
+        finally:
+            if github_repo is not None:
+                os.environ["GITHUB_REPOSITORY"] = github_repo
 
 
 # --------------------------------------------

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/test/helpers.py

@@ -39,7 +39,7 @@ def mkdocs_conf(request: pytest.FixtureRequest, tmp_path: Path) -> Iterator[MkDo
     ):
         request = request._parent_request  # type: ignore
     mkdocstring_config = {"default_handler": "github"}
-    marker = request.node.get_closest_marker("without_handler")
+    marker = request.node.get_closest_marker("without_repo")
     if marker is None:
         mkdocstring_config["handlers"] = {
             "github": {"repo": "watermarkhu/mkdocstrings-github-fixture"}
@@ -110,8 +110,6 @@ def handler(plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> GitHubHandler
     handler: GitHubHandler = plugin.handlers.get_handler(  # ty: ignore[invalid-assignment]
         "github"
     )
-    handler.major = "v1"
-    handler.semver = "v1.2.3"
     handler._update_env(ext_markdown)
     return handler
 

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/test/snapshots/__init__.py

@@ -4,6 +4,13 @@ register_format_alias(".html", ".txt")
 
 workflow_show = snapshot(
     {
+        (
+            ("show_signature", True),
+            ("signature_version", "major"),
+            ("signature_version_string", ""),
+            ("signature_show_secrets", True),
+            ("signature_show_permissions", True),
+        ): external("hash:d2e25cb02f37*.html"),
         (("show_description", True), ("description", ""), ("show_source", True)): external(
             "hash:78f74a133e98*.html"
         ),
@@ -36,20 +43,13 @@ workflow_show = snapshot(
             ("show_toc_entry", True),
             ("toc_label", ""),
         ): external("hash:1322d6390dbc*.html"),
-        (
-            ("show_signature", True),
-            ("signature_version", "major"),
-            ("signature_version_string", ""),
-            ("signature_show_secrets", True),
-            ("signature_show_permissions", True),
-        ): external("hash:d2e25cb02f37*.html"),
         (
             ("show_signature", True),
             ("signature_version", "semver"),
             ("signature_version_string", ""),
             ("signature_show_secrets", True),
             ("signature_show_permissions", False),
-        ): external("hash:cdf58c1c57a8*.html"),
+        ): external("hash:580dbb72a430*.html"),
         (
             ("show_signature", True),
             ("signature_version", "string"),
@@ -176,6 +176,76 @@ action_show = snapshot(
         (("show_description", False), ("description", ""), ("show_source", False)): external(
             "hash:5a2f11e94bc0*.html"
         ),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:2eb63f18b2d0*.html"),
+        (
+            ("show_heading", True),
+            ("heading", "Custom heading"),
+            ("heading_level", 2),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", "Custom toc label"),
+        ): external("hash:856a4ff20ee1*.html"),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", True),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:0a37a4286738*.html"),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 2),
+            ("show_branding", True),
+            ("branding_icon", "green"),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:3cb099624d88*.html"),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 3),
+            ("show_branding", True),
+            ("branding_icon", ""),
+            ("branding_icon_color", "github"),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:c50b7f91aaff*.html"),
+        (
+            ("show_heading", False),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", True),
+            ("toc_label", ""),
+        ): external("hash:c8c895c400f0*.html"),
+        (
+            ("show_heading", False),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:36d559797138*.html"),
         (
             ("show_signature", True),
             ("signature_version", "major"),
@@ -185,7 +255,7 @@ action_show = snapshot(
             ("show_signature", True),
             ("signature_version", "semver"),
             ("signature_version_string", ""),
-        ): external("hash:1bb484ae2f4d*.html"),
+        ): external("hash:5f8858f37fdd*.html"),
         (
             ("show_signature", True),
             ("signature_version", "string"),
@@ -280,75 +350,5 @@ action_show = snapshot(
             ("parameters_order", "source"),
             ("parameters_section_style", "list"),
         ): external("hash:cdad9a8909ec*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:2eb63f18b2d0*.html"),
-        (
-            ("show_heading", True),
-            ("heading", "Custom heading"),
-            ("heading_level", 2),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", "Custom toc label"),
-        ): external("hash:856a4ff20ee1*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", True),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:0a37a4286738*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 2),
-            ("show_branding", True),
-            ("branding_icon", "green"),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:3cb099624d88*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 3),
-            ("show_branding", True),
-            ("branding_icon", ""),
-            ("branding_icon_color", "github"),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:c50b7f91aaff*.html"),
-        (
-            ("show_heading", False),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", True),
-            ("toc_label", ""),
-        ): external("hash:c8c895c400f0*.html"),
-        (
-            ("show_heading", False),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:36d559797138*.html"),
     }
 )

mkdocstrings_github-0.4.1/test/snapshots/external/cdf58c1c57a805ff06487f8361728c09ddf37f7ef3235ad26effab9f1f07f5a4.html → mkdocstrings_github-0.4.3/test/snapshots/external/580dbb72a43006671d311475eebd6a9473776f0637b33fd2dcef405dfe054567.html

@@ -14,7 +14,7 @@
  <h1 class="doc doc-heading" id=".github/workflows/reusable-workflow.yml">
  </h1>
  <div class="highlight">
-  <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@v1.2.3</span>
+  <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@v1.0.1</span>
 <span class="nt">with</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
 <span class="nt">secrets</span><span class="p">:</span>

mkdocstrings_github-0.4.1/test/snapshots/external/1bb484ae2f4d2bfc6473c265761d6ba4f76c5be5dbd3a9059758e67589f4b320.html → mkdocstrings_github-0.4.3/test/snapshots/external/5f8858f37fdd6904be6fa07c66a28b0970f569174cab5087c28c710cac24cd92.html

@@ -12,7 +12,7 @@
  <h1 class="doc doc-heading" id=".">
  </h1>
  <div class="highlight">
-  <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@v1.2.3</span>
+  <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@v1.0.1</span>
 <span class="w">  </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
 </code></pre>

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/test/test_handler.py

@@ -13,25 +13,6 @@ if TYPE_CHECKING:
     pass
 
 
-def test_collected_workflows_actions(handler: GitHubHandler) -> None:
-    """Assert error is raised for missing identifiers."""
-
-    assert {workflow.name for workflow in handler.workflows.keys()} == {
-        "reusable-workflow.yml",
-        "hybrid-workflow.yml",
-    }, "Workflows should be loaded correctly."
-
-    assert {action.parent.name for action in handler.actions.keys()} == {
-        "javascript-action",
-        "minimal-action",
-        "complex-action",
-        "simple-action",
-        "fixture",
-        "docker-action",
-        "deep-action",
-    }, "Actions should be loaded correctly."
-
-
 @pytest.mark.parametrize(
     ("identifier", "name"),
     [
@@ -68,6 +49,33 @@ def test_collect_action(handler: GitHubHandler, identifier: str, name: str) -> N
 def test_collect_missing_identifier(handler: GitHubHandler) -> None:
     """Assert error is raised for missing identifiers."""
     with pytest.raises(
-        CollectionError, match="Identifier 'missing.yml' not found as a workflow or action."
+        CollectionError, match="Identifier 'missing.yml' is not a valid workflow file."
     ):
         handler.collect("missing.yml", {})
+
+    with pytest.raises(
+        CollectionError,
+        match="Identifier 'README.md' is not a valid workflow file or action directory.",
+    ):
+        handler.collect("README.md", {})
+
+    with pytest.raises(
+        CollectionError,
+        match="Identifier 'actions' is not a valid workflow file or action directory.",
+    ):
+        handler.collect("actions", {})
+
+
+@pytest.mark.without_repo
+@pytest.mark.github_actions
+def test_collect_repo_github_actions(handler: GitHubHandler) -> None:
+    """Assert error is raised when no repo is configured."""
+    assert handler.config.repo == "watermarkhu/mkdocstrings-github", (
+        "Could not get repository from env"
+    )
+
+
+@pytest.mark.without_repo
+def test_collect_repo_git(handler: GitHubHandler) -> None:
+    """Assert error is raised when no repo is configured."""
+    assert handler.config.repo == "watermarkhu/mkdocstrings-github-fixture"

{mkdocstrings_github-0.4.1 → mkdocstrings_github-0.4.3}/uv.lock

@@ -716,11 +716,12 @@ wheels = [
 
 [[package]]
 name = "mkdocstrings-github"
-version = "0.4.1"
+version = "0.4.3"
 source = { editable = "." }
 dependencies = [
     { name = "gitpython" },
     { name = "mkdocstrings" },
+    { name = "packaging" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'" },
 ]
 
@@ -750,6 +751,7 @@ docs = [
 requires-dist = [
     { name = "gitpython", specifier = "~=3.1.45" },
     { name = "mkdocstrings", specifier = "~=0.29" },
+    { name = "packaging", specifier = "~=25.0" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'", specifier = ">=4.0" },
 ]
 
@@ -763,7 +765,7 @@ dev = [
     { name = "pytest-cov", specifier = "~=7.0.0" },
     { name = "python-semantic-release", specifier = "~=10.4.1" },
     { name = "ruff", specifier = "~=0.14.0" },
-    { name = "ty", specifier = "~=0.0.1a19" },
+    { name = "ty", specifier = "~=0.0.1a22" },
 ]
 docs = [
     { name = "griffe-pydantic", specifier = "~=1.1.7" },
@@ -1315,27 +1317,27 @@ wheels = [
 
 [[package]]
 name = "ty"
-version = "0.0.1a21"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/b7/0f/65606ccee2da5a05a3c3362f5233f058e9d29d3c5521697c7ae79545d246/ty-0.0.1a21.tar.gz", hash = "sha256:e941e9a9d1e54b03eeaf9c3197c26a19cf76009fd5e41e16e5657c1c827bd6d3", size = 4263980, upload-time = "2025-09-19T06:54:06.412Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/d3/7a/c87a42d0a45cfa2d5c06c8d66aa1b243db16dc31b25e545fb0263308523b/ty-0.0.1a21-py3-none-linux_armv6l.whl", hash = "sha256:1f276ceab23a1410aec09508248c76ae0989c67fb7a0c287e0d4564994295531", size = 8421116, upload-time = "2025-09-19T06:53:35.029Z" },
-    { url = "https://files.pythonhosted.org/packages/99/c2/721bf4fa21c84d4cdae0e57a06a88e7e64fc2dca38820232bd6cbeef644f/ty-0.0.1a21-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:3c3bc66fcae41eff133cfe326dd65d82567a2fb5d4efe2128773b10ec2766819", size = 8512556, upload-time = "2025-09-19T06:53:37.455Z" },
-    { url = "https://files.pythonhosted.org/packages/6c/58/b0585d9d61673e864a87e95760dfa2a90ac15702e7612ab064d354f6752a/ty-0.0.1a21-py3-none-macosx_11_0_arm64.whl", hash = "sha256:cc0880ec344fbdf736b05d8d0da01f0caaaa02409bd9a24b68d18d0127a79b0e", size = 8109188, upload-time = "2025-09-19T06:53:39.469Z" },
-    { url = "https://files.pythonhosted.org/packages/ea/08/edf7b59ba24bb1a1af341207fc5a0106eb1fe4264c1d7fb672c171dd2daf/ty-0.0.1a21-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:334d2a212ebf42a0e55d57561926af7679fe1e878175e11dcb81ad8df892844e", size = 8279000, upload-time = "2025-09-19T06:53:41.309Z" },
-    { url = "https://files.pythonhosted.org/packages/05/8e/4b5e562623e0aa24a3972510287b4bc5d98251afb353388d14008ea99954/ty-0.0.1a21-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a8c769987d00fbc33054ff7e342633f475ea10dc43bc60fb9fb056159d48cb90", size = 8243261, upload-time = "2025-09-19T06:53:42.736Z" },
-    { url = "https://files.pythonhosted.org/packages/c3/09/6476fa21f9962d5b9c8e8053fd0442ed8e3ceb7502e39700ab1935555199/ty-0.0.1a21-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:218d53e7919e885bd98e9196d9cb952d82178b299aa36da6f7f39333eb7400ed", size = 9150228, upload-time = "2025-09-19T06:53:44.242Z" },
-    { url = "https://files.pythonhosted.org/packages/d2/96/49c158b6255fc1e22a5701c38f7d4c1b7f8be17a476ce9226fcae82a7b36/ty-0.0.1a21-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:84243455f295ed850bd53f7089819321807d4e6ee3b1cbff6086137ae0259466", size = 9628323, upload-time = "2025-09-19T06:53:45.998Z" },
-    { url = "https://files.pythonhosted.org/packages/f4/65/37a8a5cb7b3254365c54b5e10f069e311c4252ed160b86fabd1203fbca5c/ty-0.0.1a21-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:87a200c21e02962e8a27374d9d152582331d57d709672431be58f4f898bf6cad", size = 9251233, upload-time = "2025-09-19T06:53:48.042Z" },
-    { url = "https://files.pythonhosted.org/packages/a3/30/5b06120747da4a0f0bc54a4b051b42172603033dbee0bcf51bce7c21ada9/ty-0.0.1a21-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:be8f457d7841b7ead2a3f6b65ba668abc172a1150a0f1f6c0958af3725dbb61a", size = 8996186, upload-time = "2025-09-19T06:53:49.753Z" },
-    { url = "https://files.pythonhosted.org/packages/af/fc/5aa122536b1acb57389f404f6328c20342242b78513a60459fee9b7d6f27/ty-0.0.1a21-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1474d883129bb63da3b2380fc7ead824cd3baf6a9551e6aa476ffefc58057af3", size = 8722848, upload-time = "2025-09-19T06:53:51.566Z" },
-    { url = "https://files.pythonhosted.org/packages/3a/c1/456dcc65a149df8410b1d75f0197a31d4beef74b7bb44cce42b03bf074e8/ty-0.0.1a21-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:0efba2e52b58f536f4198ba5c4a36cac2ba67d83ec6f429ebc7704233bcda4c3", size = 8220727, upload-time = "2025-09-19T06:53:53.753Z" },
-    { url = "https://files.pythonhosted.org/packages/a4/86/b37505d942cd68235be5be407e43e15afa36669aaa2db9b6e5b43c1d9f91/ty-0.0.1a21-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:5dfc73299d441cc6454e36ed0a976877415024143dfca6592dc36f7701424383", size = 8279114, upload-time = "2025-09-19T06:53:55.343Z" },
-    { url = "https://files.pythonhosted.org/packages/55/fe/0d9816f36d258e6b2a3d7518421be17c68954ea9a66b638de49588cc2e27/ty-0.0.1a21-py3-none-musllinux_1_2_i686.whl", hash = "sha256:ba13d03b9e095216ceb4e4d554a308517f28ab0a6e4dcd07cfe94563e4c2c489", size = 8701798, upload-time = "2025-09-19T06:53:57.17Z" },
-    { url = "https://files.pythonhosted.org/packages/4e/7a/70539932e3e5a36c54bd5432ff44ed0c301c41a528365d8de5b8f79f4317/ty-0.0.1a21-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:9463cac96b8f1bb5ba740fe1d42cd6bd152b43c5b159b2f07f8fd629bcdded34", size = 8872676, upload-time = "2025-09-19T06:53:59.357Z" },
-    { url = "https://files.pythonhosted.org/packages/ea/94/809d85f6982841fe28526ace3b282b0458d0a96bbc6b1a982d9269a5e481/ty-0.0.1a21-py3-none-win32.whl", hash = "sha256:ecf41706b803827b0de8717f32a434dad1e67be9f4b8caf403e12013179ea06a", size = 8003866, upload-time = "2025-09-19T06:54:01.393Z" },
-    { url = "https://files.pythonhosted.org/packages/50/16/b3e914cec2a6344d2c30d3780ca6ecd39667173611f8776cecfd1294eab9/ty-0.0.1a21-py3-none-win_amd64.whl", hash = "sha256:7505aeb8bf2a62f00f12cfa496f6c965074d75c8126268776565284c8a12d5dd", size = 8675300, upload-time = "2025-09-19T06:54:02.893Z" },
-    { url = "https://files.pythonhosted.org/packages/16/0b/293be6bc19f6da5e9b15e615a7100504f307dd4294d2c61cee3de91198e5/ty-0.0.1a21-py3-none-win_arm64.whl", hash = "sha256:21f708d02b6588323ffdbfdba38830dd0ecfd626db50aa6006b296b5470e52f9", size = 8193800, upload-time = "2025-09-19T06:54:04.583Z" },
+version = "0.0.1a22"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/bb/87/eab73cdc990d1141b60237379975efc0e913bfa0d19083daab0f497444a6/ty-0.0.1a22.tar.gz", hash = "sha256:b20ec5362830a1e9e05654c15e88607fdbb45325ec130a9a364c6dd412ecbf55", size = 4312182, upload-time = "2025-10-10T13:07:15.88Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/4d/30/83e2dbfbc70de8a1932b19daf05ce803d7d76cdc6251de1519a49cf1c27d/ty-0.0.1a22-py3-none-linux_armv6l.whl", hash = "sha256:6efba0c777881d2d072fa7375a64ad20357e825eff2a0b6ff9ec80399a04253b", size = 8581795, upload-time = "2025-10-10T13:06:44.396Z" },
+    { url = "https://files.pythonhosted.org/packages/d7/8c/5193534fc4a3569f517408828d077b26d6280fe8c2dd0bdc63db4403dcdb/ty-0.0.1a22-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:2ada020eebe1b44403affdf45cd5c8d3fb8312c3e80469d795690093c0921f55", size = 8682602, upload-time = "2025-10-10T13:06:46.44Z" },
+    { url = "https://files.pythonhosted.org/packages/22/4a/7ba53493bf37b61d3e0dfe6df910e6bc74c40d16c3effd84e15c0863d34e/ty-0.0.1a22-py3-none-macosx_11_0_arm64.whl", hash = "sha256:ed4f11f1a5824ea10d3e46b1990d092c3f341b1d492c357d23bed2ac347fd253", size = 8278839, upload-time = "2025-10-10T13:06:48.688Z" },
+    { url = "https://files.pythonhosted.org/packages/52/0a/d9862c41b9615de56d2158bfbb5177dbf5a65e94922d3dd13855f48cb91b/ty-0.0.1a22-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:56f48d8f94292909d596dbeb56ff7f9f070bd316aa628b45c02ca2b2f5797f31", size = 8421483, upload-time = "2025-10-10T13:06:50.75Z" },
+    { url = "https://files.pythonhosted.org/packages/a5/cb/3ebe0e45b80724d4c2f849fdf304179727fd06df7fee7cd12fe6c3efe49d/ty-0.0.1a22-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:733e9ac22885b6574de26bdbae439c960a06acc825a938d3780c9d498bb65339", size = 8419225, upload-time = "2025-10-10T13:06:52.533Z" },
+    { url = "https://files.pythonhosted.org/packages/4f/b5/da65f3f8ad31d881ca9987a3f6f26069a0cc649c9354adb7453ca62116bb/ty-0.0.1a22-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5135d662484e56809c77b3343614005585caadaa5c1cf643ed6a09303497652b", size = 9352336, upload-time = "2025-10-10T13:06:54.476Z" },
+    { url = "https://files.pythonhosted.org/packages/a3/24/9c46f2eb16734ab0fcf3291486b1c5c528a1569f94541dc1f19f97dd2a5b/ty-0.0.1a22-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:87f297f99a98154d33a3f21991979418c65d8bf480f6a1bad1e54d46d2dc7df7", size = 9857840, upload-time = "2025-10-10T13:06:56.514Z" },
+    { url = "https://files.pythonhosted.org/packages/d8/ae/930c94bbbe5c049eae5355a197c39522844f55c7ab7fccd0ba061f618541/ty-0.0.1a22-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3310217eaa4dccf20b7336fcbeb072097addc6fde0c9d3f791dea437af0aa6dc", size = 9452611, upload-time = "2025-10-10T13:06:58.154Z" },
+    { url = "https://files.pythonhosted.org/packages/a2/80/d8f594438465c352cf0ebd4072f5ca3be2871153a3cd279ed2f35ecd487c/ty-0.0.1a22-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:12b032e81012bf5228fd65f01b50e29eb409534b6aac28ee5c48ee3b7b860ddf", size = 9214875, upload-time = "2025-10-10T13:06:59.861Z" },
+    { url = "https://files.pythonhosted.org/packages/fd/07/f852fb20ac27707de495c39a02aeb056e3368833b7e12888d43b1f61594d/ty-0.0.1a22-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a3ffda8149cab0000a21e7a078142073e27a1a9ac03b9a0837aa2f53d1fbebcb", size = 8906715, upload-time = "2025-10-10T13:07:01.926Z" },
+    { url = "https://files.pythonhosted.org/packages/40/4d/0e0b85b4179891cc3067a6e717f5161921c07873a4f545963fdf1dd3619c/ty-0.0.1a22-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:afa512e7dc78f0cf0b55f87394968ba59c46993c67bc0ef295962144fea85b12", size = 8350873, upload-time = "2025-10-10T13:07:03.999Z" },
+    { url = "https://files.pythonhosted.org/packages/a1/1f/e70c63e12b4a0d97d4fd6f872dd199113666ad1b236e18838fa5e5d5502d/ty-0.0.1a22-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:069cdbbea6025f7ebbb5e9043c8d0daf760358df46df8304ef5ca5bb3e320aef", size = 8442568, upload-time = "2025-10-10T13:07:05.745Z" },
+    { url = "https://files.pythonhosted.org/packages/de/3b/55518906cb3598f2b99ff1e86c838d77d006cab70cdd2a0a625d02ccb52c/ty-0.0.1a22-py3-none-musllinux_1_2_i686.whl", hash = "sha256:67d31d902e6fd67a4b3523604f635e71d2ec55acfb9118f984600584bfe0ff2a", size = 8896775, upload-time = "2025-10-10T13:07:08.02Z" },
+    { url = "https://files.pythonhosted.org/packages/c3/ea/60c654c27931bf84fa9cb463a4c4c49e8869c052fa607a6e930be717b619/ty-0.0.1a22-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:f9e154f262162e6f76b01f318e469ac6c22ffce22b010c396ed34e81d8369821", size = 9054544, upload-time = "2025-10-10T13:07:09.675Z" },
+    { url = "https://files.pythonhosted.org/packages/6c/60/9a6d5530d6829ccf656e6ae0fb13d70a4e2514f4fb8910266ebd54286620/ty-0.0.1a22-py3-none-win32.whl", hash = "sha256:37525433ca7b02a8fca4b8fa9dcde818bf3a413b539b9dbc8f7b39d124eb7c49", size = 8165703, upload-time = "2025-10-10T13:07:11.378Z" },
+    { url = "https://files.pythonhosted.org/packages/14/9c/ac08c832643850d4e18cbc959abc69cd51d531fe11bdb691098b3cf2f562/ty-0.0.1a22-py3-none-win_amd64.whl", hash = "sha256:75d21cdeba8bcef247af89518d7ce98079cac4a55c4160cb76682ea40a18b92c", size = 8828319, upload-time = "2025-10-10T13:07:12.815Z" },
+    { url = "https://files.pythonhosted.org/packages/22/df/38068fc44e3cfb455aeb41d0ff1850a4d3c9988010466d4a8d19860b8b9a/ty-0.0.1a22-py3-none-win_arm64.whl", hash = "sha256:1c7f040fe311e9696917417434c2a0e58402235be842c508002c6a2eff1398b0", size = 8367136, upload-time = "2025-10-10T13:07:14.518Z" },
 ]
 
 [[package]]