mkdocstrings-github 0.2.3__tar.gz → 0.2.5__tar.gz

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/.github/workflows/qualify.yaml

@@ -21,7 +21,6 @@ concurrency:
 
 jobs:
   docs:
-    if: contains(github.event.pull_request.labels.*.name, 'documentation')
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
     concurrency:
@@ -32,9 +31,9 @@ jobs:
     secrets: inherit
     with:
       version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
-      alias: ""
+      alias: "test"
       set-default: false
-      push: true
+      push: ${{ contains(github.event.pull_request.labels.*.name, 'documentation') }}
 
   setup:
     runs-on: ubuntu-latest

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/.github/workflows/release.yaml

@@ -180,6 +180,7 @@ jobs:
         continue-on-error: true
         env:
           VERSION: ${{ format('pr-{0}', github.head_ref) || 'test' }}
+          GH_TOKEN: ${{ github.token }}
         run: >
           uv run mike delete 
           --push --ignore-remote-status 

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.2.3
+Version: 0.2.5
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT

mkdocstrings_github-0.2.5/docs/changelog.md

@@ -0,0 +1 @@
+# changelog

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/docs/usage/index.md

@@ -98,7 +98,10 @@ plugins:
 
 ### Global-only options
 
-Some options are **global only, and go directly under the handler's name.
+Some options are **global only**, and go directly under the handler's name.
+
+::: mkdocstrings_handlers.github.config.GitHubConfig.hostname
+    handler: python
 
 ::: mkdocstrings_handlers.github.config.GitHubConfig.repo
     handler: python
@@ -121,7 +124,6 @@ plugins:
 
 ...and locally, overriding the global configuration:
 
-
 ```markdown title="docs/some_page.md"
 ::: .github/workflows/reusable-workflow.yml
     handler: github
@@ -136,7 +138,6 @@ These options affect how the documentation is collected from sources and rendere
 - [Signature options](./signatures.md): options related to the shown call signature.
 - [Parameters options](./parameters.md): options related to the input (and output) parameters of the action or workflow.
 
-
 ::: mkdocstrings_handlers.github.config.GitHubOptions
     handler: python
     options:

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/docs/usage/signatures.md

@@ -14,7 +14,6 @@
         --8<-- ".github/workflows/example_workflow.yml"
         ```
 
-
 ::: mkdocstrings_handlers.github.config.GitHubOptions.show_signature
     handler: python
 
@@ -84,9 +83,9 @@
         mkdocs build 
     ```
 
-!!! info 
+!!! info
 
-    For GitHub Enterprise instances, you need to additionally set the `GH_HOST` environment variable to your GitHub hostname. 
+    For GitHub Enterprise instances, you can set either the [`hostname`][mkdocstrings_handlers.github.config.GitHubConfig.hostname] configuration option or the `GH_HOST` environment variable to your GitHub hostname.
 
 ??? preview
 

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/mkdocs.yml

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

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.2.3"
+version = "0.2.5"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -120,6 +120,9 @@ prerelease = false
 [tool.semantic_release.commit_parser_options]
 patch_tags = ["fix", "perf", "chore"]
 
+[tool.semantic_release.changelog]
+changelog_file = "docs/changelog.md"
+
 [tool.pytest.ini_options]
 pythonpath = [
     "test"

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/src/mkdocstrings_handlers/github/config.py

@@ -171,6 +171,11 @@ class GitHubOptions(BaseModel):
 class GitHubConfig(BaseModel):
     """Configuration options for the GitHub handler."""
 
+    hostname: str = Field(
+        default="github.com",
+        description="The hostname of the GitHub instance to use. This is only needed for GitHub Enterprise installations.",
+    )
+
     repo: str = Field(
         default="",
         description="""The GitHub repository in the format *owner/repo*.

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/src/mkdocstrings_handlers/github/handler.py

@@ -74,76 +74,13 @@ class GitHubHandler(BaseHandler):
         self.major: str = ""
         self.semver: str = ""
 
-        # Only run GitHub releases code if not running under pytest
-        if (
+        # 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
-        ) and "pytest" not in sys.modules:
-            # Use PyGitHub to find last GitHub releases with tags matching vX.X.X and vX
-
-            GH_HOST = os.environ.get("GH_HOST", "https://api.github.com")
-
-            if (token_key := "GH_TOKEN") in os.environ:
-                gh = Github(base_url=GH_HOST, auth=Auth.Token(os.environ[token_key]))
-            elif (token_key := "GITHUB_TOKEN") in os.environ:
-                gh = Github(base_url=GH_HOST, auth=Auth.Token(os.environ[token_key]))
-            else:
-                try:
-                    gh = Github(base_url=GH_HOST, auth=Auth.NetrcAuth())
-                except RuntimeError:
-                    try:
-                        token = subprocess.check_output(["gh", "auth", "token"], text=True).strip()
-                        if token:
-                            gh = Github(base_url=GH_HOST, auth=Auth.Token(token))
-                        else:
-                            raise RuntimeError("No token from gh auth token")
-                    except Exception:
-                        _logger.warning(
-                            "Could not authenticate with GitHub to get releases. "
-                            "Consider setting .netrc, environment variable GH_TOKEN, "
-                            "or using GitHub CLI (`gh auth login`) to get GitHub releases.",
-                        )
-                        gh = Github(base_url=GH_HOST)
-
-            owner, repo_name = self.config.repo.split("/", 1)
-            gh_repo = gh.get_repo(f"{owner}/{repo_name}")
-            releases = list(gh_repo.get_releases())
-            for release in releases:
-                tag = release.tag_name
-                if not self.semver and SEMVER_PATTERN.match(tag):
-                    self.semver = tag
-                if not self.major and MAJOR_PATTERN.match(tag):
-                    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(
-                    "Could not find suitable GitHub releases for repo '%s'. "
-                    "Make sure there are releases with tags matching %s, "
-                    "if you wish to use option signature_version %s.",
-                    self.config.repo,
-                    messages[0],
-                    messages[1],
-                )
-
-        if self.config.repo == ".":
-            url = next(repo.remote("origin").urls)
-            match = re.search(r"github.com[:/](?P<owner>[^/]+)/(?P<repo>[^/.]+)", url)
-            if match:
-                self.config.repo = f"{match.group('owner')}/{match.group('repo')}"
-            else:
-                _logger.warning(
-                    "Could not determine GitHub repository automatically from git remote URL '%s'. "
-                    "Make sure the remote URL is a GitHub URL, "
-                    "or set the 'repo' option in the configuration.",
-                    url,
-                )
+        )
+        if not_testing and no_custom_tags:
+            self.get_releases()
 
         # Glob all workflow YAML files using pathlib
         working_tree_dir = Path(repo.working_tree_dir)
@@ -170,6 +107,98 @@ class GitHubHandler(BaseHandler):
             if action is not None:
                 self.actions[action_file] = action
 
+    def get_releases(self) -> None:
+        gh_host = os.environ.get("GH_HOST", self.config.hostname)
+        if gh_host.startswith(("http://", "https://")):
+            base_url = gh_host
+        elif "/api/" in gh_host:
+            # If protocol is missing, default to https
+            base_url = f"https://{gh_host}"
+        elif gh_host.startswith("api."):
+            base_url = f"https://{gh_host}"
+        else:
+            base_url = f"https://api.{gh_host}"
+
+        _logger.debug(f"Using GitHub API base URL: {base_url}")
+
+        if (token_key := "GH_TOKEN") in os.environ:
+            gh = Github(base_url=base_url, auth=Auth.Token(os.environ[token_key]))
+            _logger.debug(f"Using GitHub authentication from environment variable {token_key}")
+        elif (token_key := "GITHUB_TOKEN") in os.environ:
+            gh = Github(base_url=base_url, auth=Auth.Token(os.environ[token_key]))
+            _logger.debug(f"Using GitHub authentication from environment variable {token_key}")
+        else:
+            try:
+                gh = Github(base_url=base_url, auth=Auth.NetrcAuth())
+                _logger.debug("Using GitHub authentication from .netrc")
+            except RuntimeError:
+                try:
+                    token = subprocess.check_output(
+                        ["gh", "auth", "token"], text=True, env=os.environ
+                    ).strip()
+                    if token:
+                        gh = Github(base_url=base_url, auth=Auth.Token(token))
+                        _logger.debug("Using GitHub authentication from gh cli.")
+                    else:
+                        raise RuntimeError("No token from gh auth token")
+                except Exception:
+                    _logger.warning(
+                        "Could not authenticate with GitHub to get releases. "
+                        "Consider setting .netrc, environment variable GH_TOKEN, "
+                        "or using GitHub CLI (`gh auth login`) to get GitHub releases.",
+                    )
+                    gh = Github(base_url=base_url)
+
+        # Determine owner and repo name
+        if "/" in self.config.repo:
+            owner, repo_name = self.config.repo.split("/", 1)
+        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}"
+
+        # Get releases
+        gh_repo = gh.get_repo(f"{owner}/{repo_name}")
+        releases = list(gh_repo.get_releases())
+        for release in releases:
+            tag = release.tag_name
+            if not self.semver and SEMVER_PATTERN.match(tag):
+                self.semver = tag
+            if not self.major and MAJOR_PATTERN.match(tag):
+                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 GitHub releases for repo '{self.config.repo}'. "
+                f"Make sure there are releases with tags matching {messages[0]}, "
+                f"if you wish to use option signature_version {messages[1]}.",
+            )
+
     def get_options(self, local_options: Mapping[str, Any]) -> HandlerOptions:
         """Get combined default, global and local options.
 

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.5}/uv.lock

@@ -788,7 +788,7 @@ wheels = [
 
 [[package]]
 name = "mkdocstrings-github"
-version = "0.2.3"
+version = "0.2.5"
 source = { editable = "." }
 dependencies = [
     { name = "gitpython" },

mkdocstrings_github-0.2.3/CHANGELOG.md

@@ -1 +0,0 @@
-# CHANGELOG

mkdocstrings_github-0.2.3/docs/changelog.md

@@ -1 +0,0 @@
---8<-- "CHANGELOG.md"