mkdocstrings-github 0.5.0__tar.gz → 0.5.1__tar.gz

{mkdocstrings_github-0.5.0 → mkdocstrings_github-0.5.1}/.github/CONTRIBUTING.md

@@ -2,7 +2,18 @@
 
 Thank you for considering contributing! Please follow these steps to get started:
 
-## 1. Environment Setup
+## 1. Clone repository
+
+Clone the repository and setup its submodules. The [watermarkhu/mkdocstrings-github-fixture](https://github.com/watermarkhu/mkdocstrings-github-fixture) repository is used as a fixture repository. 
+
+```sh
+git clone https://github.com/watermarkhu/mkdocstrings-github
+cd mkdocstrings-github
+git submodule init
+git submodule update
+```
+
+## 2. Environment Setup
 
 Install all dependencies using [uv](https://github.com/astral-sh/uv):
 
@@ -12,7 +23,7 @@ uv sync --all-groups
 
 Learn more about uv: [uv documentation](https://github.com/astral-sh/uv)
 
-## 2. Pre-commit Hooks using prek
+## 3. Pre-commit Hooks using prek
 
 Set up [prek](https://github.com/j178/prek) hooks to ensure code quality:
 
@@ -22,7 +33,7 @@ uv run prek install
 
 See: [prek documentation](https://prek.j178.dev/)
 
-## 3. Running Tests
+## 4. Running Tests
 
 Run tests with [pytest](https://docs.pytest.org/en/stable/):
 
@@ -32,7 +43,7 @@ uv run pytest
 
 See: [pytest documentation](https://docs.pytest.org/en/stable/)
 
-## 4. Pull Request Guidelines
+## 5. Pull Request Guidelines
 
 - Pull requests should target the `main` branch.
 - Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.

{mkdocstrings_github-0.5.0 → mkdocstrings_github-0.5.1}/PKG-INFO

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

{mkdocstrings_github-0.5.0 → mkdocstrings_github-0.5.1}/docs/changelog.md

@@ -2,6 +2,15 @@
 
 <!-- version list -->
 
+## v0.5.1 (2025-10-14)
+
+### Bug Fixes
+
+- Do not validate signature_repository
+  ([#34](https://github.com/watermarkhu/mkdocstrings-github/pull/34),
+  [`3ead525`](https://github.com/watermarkhu/mkdocstrings-github/commit/3ead5253eb68e9a5fb5def55e807801afc1ef106))
+
+
 ## v0.5.0 (2025-10-13)
 
 ### Bug Fixes

{mkdocstrings_github-0.5.0 → mkdocstrings_github-0.5.1}/docs/usage/signatures.md

@@ -41,7 +41,7 @@
 
 ??? preview
 
-    === "`signature_repository: 'username/repo'`"
+    === "`signature_repository: username/repo`"
 
         ::: .github/workflows/example_workflow.yml
             options:

{mkdocstrings_github-0.5.0 → mkdocstrings_github-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.5.0"
+version = "0.5.1"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }

{mkdocstrings_github-0.5.0 → mkdocstrings_github-0.5.1}/src/mkdocstrings_handlers/github/config.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import re
 import sys
 from typing import Literal
 
@@ -99,7 +98,6 @@ class GitHubOptions(BaseModel):
         By default, the repository is inferred from the current git repository using the default origin remote.
         If it cannot be inferred, it must be set manually.
         """,
-        pattern=re.compile(r"^[\w.-]+/[\w.-]+$"),
     )
 
     signature_show_secrets: bool = Field(