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

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

@@ -44,7 +44,7 @@ jobs:
           ref: ${{ inputs.ref }} 
 
       - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           version: "latest"
   
@@ -59,25 +59,20 @@ jobs:
   
       - name: Build documentation with mike
         shell: bash
-        env:
-          PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
-          GH_TOKEN: ${{ github.token }}
-          VERSION: ${{ inputs.version }}
         run: |
           if [[ $VERSION =~ ^v([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
             VERSION="v${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.*"
             echo "Patching version "${{ inputs.version}}" to $VERSION"
           fi
-          uv run mike deploy ${PUSH_DEPLOY} \
+          uv run mike deploy ${{ fromJson(inputs.push) && '--push' || '' }} \
             --update-aliases \
             --branch gh-pages \
             --alias-type symlink \
-            "$VERSION" "${{ inputs.alias }}"
+            "${{ inputs.version }}" "${{ inputs.alias }}"
       
       - name: Set default alias for mike 
         if: ${{ fromJson(inputs.set-default) }}
         run: >
-          uv run mike set-default
-          --branch gh-pages 
-          --push
+          uv run mike set-default ${{ fromJson(inputs.push) && '--push' || '' }}
+          --branch gh-pages
           ${{ inputs.alias }}

{mkdocstrings_github-0.3.0 → mkdocstrings_github-0.4.1}/.github/workflows/qualify.yaml

@@ -23,9 +23,6 @@ jobs:
   docs:
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
     permissions: 
       contents: write
     secrets: inherit
@@ -33,7 +30,7 @@ jobs:
       version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
       alias: "test"
       set-default: false
-      push: ${{ contains(github.event.pull_request.labels.*.name, 'documentation') }}
+      push: false
 
   setup:
     runs-on: ubuntu-latest
@@ -73,7 +70,7 @@ jobs:
         submodules: true
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
       with:
         version: "latest"
 
@@ -146,7 +143,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 2
 

{mkdocstrings_github-0.3.0 → mkdocstrings_github-0.4.1}/.github/workflows/release.yaml

@@ -19,6 +19,7 @@ jobs:
     outputs:
       released: ${{ steps.get-version.outputs.released == 'true' }}
       next-tag: ${{ steps.get-version.outputs.next-tag }}
+      last-tag: ${{ steps.get-version.outputs.last-tag }}
 
     steps:
     - uses: actions/create-github-app-token@v2
@@ -50,7 +51,7 @@ jobs:
         git checkout -B ${{ github.ref_name }} ${{ github.sha }}
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
       with:
         version: "latest"
 
@@ -127,7 +128,7 @@ jobs:
         ref: ${{ needs.release.outputs.next-tag }}
 
     - name: Install the latest version of uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
       with:
         version: "latest"
 
@@ -146,61 +147,16 @@ jobs:
           dist/*.whl
           dist/*.tar.gz
 
-  delete-test-document:
-    name: Delete test documentation
-    runs-on: ubuntu-latest
-    if: contains(github.event.pull_request.labels.*.name, 'documentation') && (github.event.action == 'closed')
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
-    permissions:
-      contents: write
-    steps:
-      - name: checkout repository
-        uses: actions/checkout@v5
-        with: 
-          fetch-depth: 0 # Required to push to the documentation branch
-
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v6
-        with:
-          version: "latest"
-
-      - name: Sync dependencies
-        run: |
-          uv sync --no-dev --group docs
-
-      - name: Configure Git Credentials
-        run: |
-          git config --global user.name github-actions[bot]
-          git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
-          git fetch origin gh-pages:gh-pages
-  
-      - name: delete testing documentation
-        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 
-          --config-file mkdocs.yml
-          --branch gh-pages
-          $VERSION
-
   document:
     name: Deploy documentation
     needs: [release]
     if: github.event.pull_request.merged
     uses: ./.github/workflows/docs.yaml
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
     permissions:
       contents: write
     secrets: inherit
     with:
-      version: ${{ needs.release.outputs.next-tag }}
+      version: ${{ needs.release.outputs.next-tag || needs.release.outputs.last-tag }}
       alias: latest
       set-default: true
       ref: ${{ needs.release.outputs.next-tag }}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.3.0
+Version: 0.4.1
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -14,15 +14,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: <3.14,>=3.10
+Requires-Python: <3.15,>=3.10
 Requires-Dist: gitpython~=3.1.45
 Requires-Dist: mkdocstrings~=0.29
-Requires-Dist: pygithub~=2.8.1
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 
@@ -37,6 +37,7 @@ Description-Content-Type: text/markdown
 [![Qualify](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml/badge.svg?branch=main)](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-github)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-github.svg)](https://pypi.org/project/mkdocstrings-github/)
+[![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-github/graph/badge.svg?token=M6XW8UeURE)](https://codecov.io/github/watermarkhu/mkdocstrings-github)
 
 <!-- --8<-- [end:header] -->
 <!-- --8<-- [start:install] -->

{mkdocstrings_github-0.3.0 → mkdocstrings_github-0.4.1}/README.md

@@ -9,6 +9,7 @@
 [![Qualify](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml/badge.svg?branch=main)](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-github)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-github.svg)](https://pypi.org/project/mkdocstrings-github/)
+[![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-github/graph/badge.svg?token=M6XW8UeURE)](https://codecov.io/github/watermarkhu/mkdocstrings-github)
 
 <!-- --8<-- [end:header] -->
 <!-- --8<-- [start:install] -->

{mkdocstrings_github-0.3.0 → mkdocstrings_github-0.4.1}/docs/usage/index.md

@@ -100,9 +100,6 @@ plugins:
 
 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
 

{mkdocstrings_github-0.3.0 → mkdocstrings_github-0.4.1}/docs/usage/signatures.md

@@ -70,23 +70,21 @@
 
 !!! info
 
-    To automatically grab the latest `major` or `semver` release, *mkdocstrings-github* needs to access GitHub to get the releases. Authentication is set by either the environment variable `GH_TOKEN`, or via [`.netrc`](https://pygithub.readthedocs.io/en/stable/examples/Authentication.html#netrc-authentication). If both aren't available, a final attempt is made via the GitHub CLI with [`gh auth token`](https://cli.github.com/manual/gh_auth_token). 
+    To automatically grab the latest `major` or `semver` release, *mkdocstrings-github* uses local git tags matching the patterns `vX` (major) and `vX.Y.Z` (semver). Make sure your repository has appropriate tags if you wish to use these versioning options.
 
-    When building your documentation in GitHub Actions, make sure that the build step has the environment variable `GH_TOKEN` set.
+    When building your documentation in GitHub Actions, make sure that the checkout will have access to the git tags associated with the action/workflow versions. This is best done by specifying a checkout filter:
 
-    ```yaml title="Example build step"
+    ```yaml title="Example checkout"
+    ...
+    - name: checkout
+      uses: actions/checkout@v5
+      with:
+        filter: tree:0
     ...
     - name: build step
-      env:
-        GH_TOKEN: ${{ github.token }}
-      run: | 
-        mkdocs build 
+      run: mkdocs build 
     ```
 
-!!! info
-
-    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
 
     === "`signature_version: ref`"

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

@@ -1,13 +1,13 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.3.0"
+version = "0.4.1"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
 ]
 license =  { text = "MIT" }
 readme = "README.md"
-requires-python = ">=3.10, <3.14"
+requires-python = ">=3.10, <3.15"
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
@@ -18,6 +18,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Documentation",
     "Topic :: Software Development",
     "Topic :: Software Development :: Documentation",
@@ -26,7 +27,6 @@ classifiers = [
 ]
 
 dependencies = [
-    "pygithub~=2.8.1",
     "gitpython~=3.1.45",
     "mkdocstrings~=0.29",
     "typing-extensions>=4.0; python_version < '3.11'",
@@ -37,7 +37,7 @@ dev = [
     "ty~=0.0.1a19",
     "ruff~=0.14.0",
     "prek>=0.2.1",
-    "pydantic~=2.10",
+    "pydantic~=2.12",
     "pytest~=8.4.1",
     "pytest-cov~=7.0.0",
     "beautifulsoup4>=4.13.3",
@@ -54,6 +54,7 @@ docs = [
     "griffe-pydantic~=1.1.7",
 ]
 
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

{mkdocstrings_github-0.3.0 → mkdocstrings_github-0.4.1}/src/mkdocstrings_handlers/github/config.py

@@ -171,11 +171,6 @@ 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.3.0 → mkdocstrings_github-0.4.1}/src/mkdocstrings_handlers/github/handler.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import os
 import re
-import subprocess
 import sys
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, ClassVar, Mapping
@@ -18,7 +17,6 @@ from mkdocstrings import (
     get_logger,
 )
 
-from github import Auth, Github
 from mkdocstrings_handlers.github import rendering
 from mkdocstrings_handlers.github.config import GitHubConfig, GitHubOptions
 from mkdocstrings_handlers.github.objects import Action, Workflow
@@ -108,82 +106,20 @@ class GitHubHandler(BaseHandler):
                 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}")
+        # Get all tags from the local git repository
+        try:
+            tags = sorted([tag.name for tag in self.repo.tags], reverse=True)
+        except Exception as e:
+            _logger.warning(f"Could not get git tags from repository: {e}")
+            return
 
-        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
+        # Find matching tags
+        for tag in tags:
             if not self.semver and SEMVER_PATTERN.match(tag):
-                _logger.info(f"Using GitHub release tag '{tag}' for semver.")
+                _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 GitHub release tag '{tag}' for major.")
+                _logger.info(f"Using git tag '{tag}' for major.")
                 self.major = tag
             if self.semver and self.major:
                 break
@@ -196,8 +132,8 @@ class GitHubHandler(BaseHandler):
             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"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]}.",
             )