mkdocstrings-github 0.6.1__tar.gz → 0.6.3__tar.gz

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/.github/workflows/docs.yaml

@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # Required to push to the documentation branch
           ref: ${{ inputs.ref }} 

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/.github/workflows/qualify.yaml

@@ -40,7 +40,7 @@ jobs:
       python-versions: ${{ steps.get-versions.outputs.python-versions }}
     steps:
     - name: Checkout code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
     
     - name: Get Python versions from pyproject.toml
       id: get-versions
@@ -65,7 +65,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       with:
         submodules: true
 
@@ -143,7 +143,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 2
 

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/.github/workflows/release.yaml

@@ -39,7 +39,7 @@ jobs:
         git config --global user.email '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com'
 
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       with:
         fetch-depth: 0
         ref: ${{ github.sha }}
@@ -123,7 +123,7 @@ jobs:
       id-token: write
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       with:
         ref: ${{ needs.release.outputs.next-tag }}
 

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.6.1
+Version: 0.6.3
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -22,7 +22,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.15,>=3.10
 Requires-Dist: gitpython<4,>=3.1.45
-Requires-Dist: mkdocstrings<1,>=0.29
+Requires-Dist: mkdocstrings<2,>=1
 Requires-Dist: ruamel-yaml<1,>=0.18.16
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/docs/changelog.md

@@ -2,6 +2,33 @@
 
 <!-- version list -->
 
+## v0.6.3 (2025-12-09)
+
+### Bug Fixes
+
+- Multiline comments ([#46](https://github.com/watermarkhu/mkdocstrings-github/pull/46),
+  [`3787e44`](https://github.com/watermarkhu/mkdocstrings-github/commit/3787e4437bd879ae779ff4d128827ed407385131))
+
+
+## v0.6.2 (2025-11-30)
+
+### Chores
+
+- **deps**: Update group-pyproject
+  ([#45](https://github.com/watermarkhu/mkdocstrings-github/pull/45),
+  [`5b13468`](https://github.com/watermarkhu/mkdocstrings-github/commit/5b1346847e9e9347ee8d9cbd84d62d23c1c82223))
+
+- **deps**: Update group-pyproject (major)
+  ([#45](https://github.com/watermarkhu/mkdocstrings-github/pull/45),
+  [`5b13468`](https://github.com/watermarkhu/mkdocstrings-github/commit/5b1346847e9e9347ee8d9cbd84d62d23c1c82223))
+
+### Continuous Integration
+
+- **deps**: Update actions/checkout action to v6
+  ([#44](https://github.com/watermarkhu/mkdocstrings-github/pull/44),
+  [`738ef72`](https://github.com/watermarkhu/mkdocstrings-github/commit/738ef727a737de1851fb4ecd556f5f4cf6c6d667))
+
+
 ## v0.6.1 (2025-11-10)
 
 ### Build System

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.6.1"
+version = "0.6.3"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -28,14 +28,14 @@ classifiers = [
 
 dependencies = [
     "gitpython>=3.1.45,<4",
-    "mkdocstrings>=0.29,<1",
+    "mkdocstrings>=1,<2",
     "ruamel.yaml>=0.18.16,<1",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
 
 [dependency-groups]
 dev = [
-    "ty~=0.0.1a22",
+    "ty~=0.0.1a29",
     "ruff~=0.14.0",
     "prek>=0.2.1",
     "pydantic~=2.12",
@@ -50,7 +50,7 @@ docs = [
     "mkdocs-callouts~=1.15",
     "mkdocs-git-revision-date-localized-plugin~=1.3",
     "mkdocs-minify-plugin~=0.8",
-    "mkdocstrings-python~=1.19.0",
+    "mkdocstrings-python~=2.0.0",
     "mike~=2.1",
     "griffe-pydantic~=1.1.7",
 ]

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/src/mkdocstrings_handlers/github/handler.py

@@ -179,7 +179,10 @@ class GitHubHandler(BaseHandler):
         self.env.globals["repository_name"] = self.get_repository_name()
 
     def collect(self, identifier: str, options: GitHubOptions) -> Workflow | Action | None:
-        path = Path(self.repo.working_tree_dir) / identifier
+        working_tree_dir = self.repo.working_tree_dir
+        if working_tree_dir is None:
+            raise CollectionError("Repository working tree directory is not available.")
+        path = Path(working_tree_dir) / identifier
 
         if path.suffix in (".yml", ".yaml"):
             if not path.is_file():
@@ -199,12 +202,15 @@ class GitHubHandler(BaseHandler):
             )
         return data
 
-    def render(self, data: Workflow | Action, options: GitHubOptions) -> str:
+    def render(
+        self, data: Workflow | Action, options: GitHubOptions, *, locale: str | None = None
+    ) -> str:
         """Render a template using provided data and configuration options.
 
         Arguments:
             data: The collected data to render.
             options: The handler's configuration options.
+            locale: The locale to use for rendering (unused in this handler).
 
         Returns:
             The rendered template as HTML.

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/src/mkdocstrings_handlers/github/objects.py

@@ -6,18 +6,21 @@ from typing import Any, Literal, Optional
 
 from ruamel.yaml import YAML
 from ruamel.yaml.comments import CommentedMap
-
-yaml = YAML()
-
+from ruamel.yaml.tokens import CommentToken
 
 GROUP_PATTERN = r"#\s*group:\s*(.+)$"
+yaml = YAML()
 
 
 def group_from_map(map: CommentedMap) -> str:
     """Extract group string from a comment line if it matches the group pattern."""
     if map.ca.comment:
-        for comment in map.ca.comment:
-            if comment is not None:
+        for comments in map.ca.comment:
+            if comments is None:
+                continue
+            elif isinstance(comments, CommentToken):
+                comments = [comments]
+            for comment in comments:
                 group_matches = re.finditer(GROUP_PATTERN, comment.value)
                 group_string = next((m.group(1).strip() for m in group_matches), "")
                 if group_string:

{mkdocstrings_github-0.6.1 → mkdocstrings_github-0.6.3}/test/test_coverage.py

@@ -213,29 +213,35 @@ jobs:
 class TestHandler:
     """Test handler module functions."""
 
-    def test_get_releases_exception_handling(self):
+    def test_get_releases_exception_handling(self, handler: GitHubHandler):
         """Test get_releases handles exception when getting git tags fails."""
-        from mkdocstrings_handlers.github.config import GitHubConfig
-        from mkdocstrings_handlers.github.handler import GitHubHandler
-
         # Create a mock repo that raises exception when accessing tags
         mock_repo = Mock()
         mock_repo.tags = Mock(side_effect=Exception("Git error"))
 
-        handler = GitHubHandler(config=GitHubConfig(), repo=mock_repo)
+        # Replace the handler's repo with our mock
+        original_repo = handler.repo
+        original_semver = handler.semver
+        original_major = handler.major
+        handler.repo = mock_repo
+        handler.semver = ""
+        handler.major = ""
 
-        # Should handle exception gracefully without raising
-        handler.get_releases()
-        assert handler.semver == ""
-        assert handler.major == ""
+        try:
+            # Should handle exception gracefully without raising
+            handler.get_releases()
+            assert handler.semver == ""
+            assert handler.major == ""
+        finally:
+            # Restore original repo and values
+            handler.repo = original_repo
+            handler.semver = original_semver
+            handler.major = original_major
 
-    def test_get_releases_with_invalid_version_tag(self, tmp_path):
+    def test_get_releases_with_invalid_version_tag(self, handler: GitHubHandler, tmp_path):
         """Test get_releases handles tags with invalid version format."""
         import git
 
-        from mkdocstrings_handlers.github.config import GitHubConfig
-        from mkdocstrings_handlers.github.handler import GitHubHandler
-
         # Create a temporary git repo with a commit
         repo = git.Repo.init(tmp_path)
 
@@ -251,18 +257,30 @@ class TestHandler:
         repo.create_tag("v1.2.3")  # Valid semver
         repo.create_tag("v99.99.99")  # Valid semver
 
-        handler = GitHubHandler(config=GitHubConfig(), repo=repo)
-        handler.get_releases()
+        # Replace the handler's repo with our test repo
+        original_repo = handler.repo
+        original_semver = handler.semver
+        original_major = handler.major
+        handler.repo = repo
+        # Reset values so get_releases starts fresh
+        handler.semver = ""
+        handler.major = ""
 
-        # Should use the latest valid semver tag
-        assert handler.semver == "v99.99.99"
-        assert handler.major == ""
+        try:
+            handler.get_releases()
 
-    def test_get_releases_with_tags_triggering_invalid_version(self):
-        """Test get_releases handles tags that trigger InvalidVersion exception."""
-        from mkdocstrings_handlers.github.config import GitHubConfig
-        from mkdocstrings_handlers.github.handler import GitHubHandler
+            # Should use the latest valid semver tag
+            assert handler.semver == "v99.99.99"
+            # No major tags (v1, v2, etc.) were created, only semver tags
+            assert handler.major == ""
+        finally:
+            # Restore original repo and values
+            handler.repo = original_repo
+            handler.semver = original_semver
+            handler.major = original_major
 
+    def test_get_releases_with_tags_triggering_invalid_version(self, handler: GitHubHandler):
+        """Test get_releases handles tags that trigger InvalidVersion exception."""
         # Create a mock repo with tags that will trigger InvalidVersion
         mock_tag1 = Mock()
         mock_tag1.name = "vinvalid"  # Matches major pattern but invalid version
@@ -273,30 +291,36 @@ class TestHandler:
         mock_repo = Mock()
         mock_repo.tags = [mock_tag1, mock_tag2]
 
-        handler = GitHubHandler(config=GitHubConfig(), repo=mock_repo)
-        handler.get_releases()
+        # Replace the handler's repo with our mock
+        original_repo = handler.repo
+        handler.repo = mock_repo
+
+        try:
+            handler.get_releases()
 
-        # Should gracefully handle the invalid version and use the valid one
-        assert handler.major == "v1"
+            # Should gracefully handle the invalid version and use the valid one
+            assert handler.major == "v1"
+        finally:
+            # Restore original repo
+            handler.repo = original_repo
 
     def test_get_options_invalid(self, handler: GitHubHandler):
         """Test get_options raises PluginError for invalid options."""
         with pytest.raises(PluginError, match="Invalid options"):
             handler.get_options({"invalid_option": "value", "heading_level": "not_an_int"})
 
-    def test_get_repository_name_no_remotes(self, tmp_path):
+    def test_get_repository_name_no_remotes(self, handler: GitHubHandler, tmp_path):
         """Test get_repository_name raises error when no valid remote is found."""
         import os
 
         import git
 
-        from mkdocstrings_handlers.github.config import GitHubConfig
-        from mkdocstrings_handlers.github.handler import GitHubHandler
-
         # Create a temporary git repo without any remotes
         repo = git.Repo.init(tmp_path)
 
-        handler = GitHubHandler(config=GitHubConfig(), repo=repo)
+        # Replace the handler's repo with our test repo
+        original_repo = handler.repo
+        handler.repo = repo
 
         # Temporarily clear GITHUB_ACTIONS and GITHUB_REPOSITORY env vars
         # to ensure the test actually checks the remote URL logic
@@ -310,6 +334,8 @@ class TestHandler:
             ):
                 handler.get_repository_name()
         finally:
+            # Restore original repo
+            handler.repo = original_repo
             # Restore environment variables
             if github_actions is not None:
                 os.environ["GITHUB_ACTIONS"] = github_actions