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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.4.1
+Version: 0.4.2
 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.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 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=d3bpciheO6BSH1EPAc8ijZ_xmcEzzhXTbfTrbcMmFIg,9310
 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
@@ -11,7 +11,7 @@ mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=jlzVF9
 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_github-0.4.2.dist-info/METADATA,sha256=humw71gGT_wkykxy7fRgxh_t1ri6JOm3keuIkoiGIyU,3340
+mkdocstrings_github-0.4.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_github-0.4.2.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
+mkdocstrings_github-0.4.2.dist-info/RECORD,,

mkdocstrings_handlers/github/handler.py

@@ -16,6 +16,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
@@ -72,6 +73,29 @@ class GitHubHandler(BaseHandler):
         self.major: str = ""
         self.semver: str = ""
 
+        # Determine owner and repo name
+        if not self.config.repo:
+            # 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}"
+
         # Only run GitHub releases code if required and not in testing
         not_testing = "pytest" not in sys.modules
         no_custom_tags = (
@@ -108,34 +132,48 @@ class GitHubHandler(BaseHandler):
     def get_releases(self) -> None:
         # 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.