mkdocstrings-github 0.7.2__tar.gz → 0.8.0__tar.gz

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/.github/renovate.json5

@@ -51,7 +51,6 @@
         "pytest-cov",
         "beautifulsoup4",
         "inline-snapshot",
-        "python-semantic-release",
       ],
       semanticCommitType: "build",
       semanticCommitScope: "deps",
@@ -65,11 +64,6 @@
       ],
       matchPackageNames: [
         "mkdocs-material",
-        "markdown-exec",
-        "mkdocs-callouts",
-        "mkdocs-git-revision-date-localized-plugin",
-        "mkdocs-minify-plugin",
-        "mike",
       ],
       semanticCommitType: "docs",
       semanticCommitScope: "deps",

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/.github/workflows/docs.yaml

@@ -14,6 +14,11 @@ on:
           Push the documentation to the remote branch
         type: boolean
         default: true
+      type:
+        description: >-
+          MkDocs or zensical
+        type: string
+        default: zensical
 
 permissions:
   contents: read
@@ -25,31 +30,35 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/configure-pages@v5
+      - uses: actions/configure-pages@v6
 
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0 # Required to push to the documentation branch
-          ref: ${{ inputs.ref }} 
+          ref: ${{ inputs.ref }}
 
       - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           version: "latest"
-  
+
       - name: Sync dependencies
+        if: inputs.type == 'zensical'
         run: |
           uv sync --no-dev --group docs
+          uv run zensical build --clean
 
       - name: Build documentation
+        if: inputs.type == 'mkdocs'
         run: |
-          uv run zensical build --clean
-        
-      - uses: actions/upload-pages-artifact@v4
+          uv sync --no-dev --group mkdocs
+          uv run mkdocs build --clean
+
+      - uses: actions/upload-pages-artifact@v5
         if: ${{ inputs.push }}
         with:
           path: site
 
-      - uses: actions/deploy-pages@v4
+      - uses: actions/deploy-pages@v5
         if: ${{ inputs.push }}
         id: deployment

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/.github/workflows/example_workflow.yml

@@ -71,7 +71,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
           
       - run: |
           echo "Validating version: ${{ inputs.version }}"

mkdocstrings_github-0.8.0/.github/workflows/qualify.yaml

@@ -0,0 +1,198 @@
+name: Qualify
+
+on:
+  merge_group:
+  push:
+    branches: [main]
+  pull_request:
+    types:
+      - opened
+      - closed
+      - reopened
+      - synchronize
+      - labeled
+      - unlabeled
+      - edited
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Test deploy documentation
+    uses: ./.github/workflows/docs.yaml
+    strategy:
+      matrix:
+        type: [mkdocs, zensical]
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    secrets: inherit
+    with:
+      push: false
+      type: ${{ matrix.type }}
+
+  setup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      python-versions: ${{ steps.get-versions.outputs.python-versions }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Get Python versions from pyproject.toml
+        id: get-versions
+        run: |
+          # Extract Python versions from classifiers
+          versions=$(grep -E "Programming Language :: Python :: 3\.[0-9]+" pyproject.toml | \
+                    sed -E 's/.*Python :: (3\.[0-9]+).*/\1/' | \
+                    sort -V | \
+                    jq -R -s -c 'split("\n")[:-1]')
+          echo "python-versions=$versions" >> $GITHUB_OUTPUT
+          echo "Found Python versions: $versions"
+
+  test:
+    name: Run checks and tests
+    needs: setup
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ${{ fromJson(needs.setup.outputs.python-versions) }}
+        resolution: [highest, lowest]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+        with:
+          submodules: true
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8.3.2
+        with:
+          version: "latest"
+
+      - name: Cache uv
+        id: cache-uv
+        uses: actions/cache@v6
+        with:
+          path: .venv
+          key: ${{ runner.os }}-qualify-uv-${{ matrix.python-version }}-${{ matrix.resolution }}-${{ github.head_ref || github.ref_name }}-${{ hashFiles('pyproject.toml') }}
+
+      - name: Install dependencies
+        env:
+          PYTHON_VERSION: ${{ matrix.python-version }}
+          UV_RESOLUTION: ${{ matrix.resolution }}
+        run: |
+          uv sync --dev --python ${PYTHON_VERSION} --resolution ${UV_RESOLUTION}
+
+      - name: Run ruff linting
+        run: |
+          echo "## 🔍 Ruff Linting Results" >> $GITHUB_STEP_SUMMARY
+          if uv run ruff check --output-format=github .; then
+            echo "✅ No linting errors found" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Linting errors found" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Run ruff formatting check
+        run: |
+          echo "## 🎨 Code Formatting Check" >> $GITHUB_STEP_SUMMARY
+          if uv run ruff format --check .; then
+            echo "✅ Code formatting is correct" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Code formatting issues found" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Run Ty type checking
+        run: |
+          echo "## 🔧 Ty Type Checking Results" >> $GITHUB_STEP_SUMMARY
+          if uv run ty check; then
+            echo "✅ No type errors found" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Type errors found" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Run tests
+        run: |
+          if uv run pytest -v --tb=short --color=yes \
+            --cov mkdocstrings_handlers.github --cov-branch --cov-report=xml \
+            --junit-xml=pytest.xml; then
+            echo '# ✅ Tests passed' >> $GITHUB_STEP_SUMMARY
+          else
+            echo '# ❌ Tests failed' >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Generate test coverage report
+        if: (!cancelled())
+        run: |
+          echo '### Test Coverage Summary' >> $GITHUB_STEP_SUMMARY
+          uv run coverage report --show-missing --format=markdown >> $GITHUB_STEP_SUMMARY
+
+      - name: Upload Test Results
+        if: (!cancelled())
+        uses: actions/upload-artifact@v7
+        with:
+          name: python${{ matrix.python-version }}-${{ matrix.resolution }}
+          path: "*.xml"
+
+  summary:
+    runs-on: ubuntu-latest
+    needs: [setup, test]
+    if: (!cancelled())
+    permissions:
+      contents: read
+      checks: write
+      id-token: write
+      pull-requests: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 2
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: results
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        with:
+          files: "results/**/pytest.xml"
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v7
+        with:
+          use_oidc: true
+          directory: results
+
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          use_oidc: true
+          directory: results
+
+      - name: Check all jobs
+        run: |
+          if [[ "${{ needs.test.result }}" == "success" ]]; then
+            echo "✅ All Python versions passed CI checks"
+            echo "## 🎉 CI Summary" >> $GITHUB_STEP_SUMMARY
+            echo "All tests passed across Python versions: ${{ needs.setup.outputs.python-versions }}" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Some Python versions failed CI checks"
+            echo "## ❌ CI Summary" >> $GITHUB_STEP_SUMMARY
+            echo "Some tests failed. Check individual job results for details." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi

mkdocstrings_github-0.8.0/.github/workflows/release.yaml

@@ -0,0 +1,110 @@
+name: Release
+
+on:
+  pull_request:
+    types:
+      - closed
+      - opened
+      - reopened
+      - synchronize
+    branches: [main]
+
+jobs:
+  release:
+    name: Semantic version release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write # Required for adding the labels to the PR
+      issues: write # Required for adding labels to the repository
+    outputs:
+      release: ${{ steps.get-version.outputs.release }}
+      tag: ${{ steps.get-version.outputs.tag }}
+      version: ${{ steps.get-version.outputs.version }}
+    steps:
+      - name: Get semantic version
+        uses: RonaldPhilipsen/semVersie@v2.3.4
+        id: get-version
+        with:
+          add-pr-label: true
+          label-prefix: false
+
+  deploy:
+    name: Deploy package distributions
+    needs: release
+    if: needs.release.outputs.release == 'true' && github.event.pull_request.merged
+    runs-on: ubuntu-latest
+    environment: release
+    defaults:
+      run:
+        shell: bash
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/create-github-app-token@v3
+        id: app-token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v8.3.2
+        with:
+          version: "latest"
+
+      - name: Checkout repository
+        uses: actions/checkout@v7
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Set credentials for git
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+          APP_SLUG: ${{ steps.app-token.outputs.app-slug }}
+          INSTALLATION_ID: ${{ steps.app-token.outputs.installation-id }}
+        run: |
+          USER_ID=$(gh api "/users/${APP_SLUG}[bot]" --jq .id)
+          git config --global user.name "${APP_SLUG}[bot]"
+          git config --global user.email "${INSTALLATION_ID}+${USER_ID}[bot]@users.noreply.github.com"
+
+      - name: Update version in pyproject.toml
+        env:
+          VERSION: ${{ needs.release.outputs.version }}
+          TAG: ${{ needs.release.outputs.tag }}
+        run: |
+          sed -i "s/version = \"0.0.0\"/version = \"${VERSION}\"/" pyproject.toml
+          git add pyproject.toml
+          git commit -m "chore: bump version to ${VERSION}"
+          git tag -a ${TAG} -m "Release ${VERSION}"
+          git push -f origin ${TAG}
+
+      - name: Build and publish package distributions
+        run: |
+          uv sync --no-dev
+          uv build
+          uv publish
+
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+          TAG: ${{ needs.release.outputs.tag }}
+        run: >
+          gh release create "${TAG}"
+          dist/*.whl
+          dist/*.tar.gz
+          --generate-notes
+          --verify-tag
+
+  document:
+    name: Deploy documentation
+    needs: [release]
+    if: github.event.pull_request.merged
+    uses: ./.github/workflows/docs.yaml
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    secrets: inherit
+    with:
+      push: true

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.7.2
+Version: 0.8.0
 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<4,>=3.1.45
 Requires-Dist: mkdocstrings<2,>=1
+Requires-Dist: ruamel-yaml-clib<1,>=0.2.14
 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.7.2 → mkdocstrings_github-0.8.0}/docs/index.md

@@ -11,7 +11,7 @@ hide:
 
 !!! note
 
-    Currently, only the [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) theme is supported.
+    Currently, either [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) or [Zensical](https://zensical.org/docs/get-started/) is supported
 
 ???+ example
 

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/docs/usage/general.md

@@ -67,7 +67,14 @@
 ::: mkdocstrings_handlers.github.config.GitHubOptions.workflow_chart
     handler: python
 
-In order to display the mermaid diagram, you'll need to setup the configuration for [Mermaid.js](https://mermaid.ai/) in [mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/diagrams/#configuration) or via [mkdocs-mermaid2](https://mkdocs-mermaid2.readthedocs.io). Following the instructions in the linked pages to configure your `mkdocs.yml`. Additionally, we recommend setting up [Panzoom for MkDocs](https://github.com/PLAYG0N/mkdocs-panzoom), which allows zooming into the displayed diagram. 
+=== "Setup for Material for MkDocs"
+
+    In order to display the mermaid diagram, you'll need to setup the configuration for [Mermaid.js](https://mermaid.ai/) in [mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/diagrams/#configuration) or via [mkdocs-mermaid2](https://mkdocs-mermaid2.readthedocs.io). Following the instructions in the linked pages to configure your `mkdocs.yml`. Additionally, we recommend setting up [Panzoom for MkDocs](https://github.com/PLAYG0N/mkdocs-panzoom), which allows zooming into the displayed diagram. 
+
+=== "Setup for Zensical"
+
+    Mermaid diagrams are supported natively by Zensical. No additional setup required.
+
 
 In the output diagram, each step in a job is represented as a node, jobs are represented as groups, and dependencies between jobs are displayed as edges between groups. Steps that call actions are rounded. Jobs that call another workflow are shown as a subroutine. Jobs and steps without `name` are **omitted** from the graph.
 

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/docs/usage/index.md

@@ -22,13 +22,22 @@ This package is an extension for [*mkdocstrings*](https://mkdocstrings.github.io
 
 --8<-- "README.md:install"
 
-The default *mkdocstrings* handler is the [Python handler](https://mkdocstrings.github.io/python). You can change the default hanlder and set the GitHub handler as default be defining the `default_handler` configuration option of `mkdocstrings` in `mkdocs.yml`:
+The default *mkdocstrings* handler is the [Python handler](https://mkdocstrings.github.io/python). You can change the default hanlder and set the GitHub handler as default be defining the `default_handler` configuration option of `mkdocstrings` in `mkdocs.yml` or `zensical.toml`
 
-```yaml title="mkdocs.yml"
-plugins:
-- mkdocstrings:
-    default_handler: github
-```
+=== "mkdocs.yaml"
+
+    ```yaml
+    plugins:
+    - mkdocstrings:
+        default_handler: github
+    ```
+
+=== "zensical.toml"
+  
+    ```toml
+    [project.plugins.mkdocstrings]
+    default_handler = "github"
+    ```
 
 ## Injecting documentation
 
@@ -88,13 +97,22 @@ For every documented action or workflow, HTML tags are inserted on the page to a
 
 When installed, the Github handler can be configured in `mkdocs.yml`
 
-```yaml title="mkdocs.yml"
-plugins:
-- mkdocstrings:
-    handlers:
-      github:
-        ... # The GitHub handler configuration
-```
+=== "mkdocs.yaml"
+
+    ```yaml
+    plugins:
+    - mkdocstrings:
+        handlers:
+          github:
+            ... # The GitHub handler configuration
+    ```
+
+=== "zensical.toml"
+
+    ```toml
+    [project.plugins.mkdocstrings.handlers.github]
+    ... # The GitHub handler configuration
+    ```
 
 ### Global-only options
 
@@ -107,14 +125,23 @@ Some options are **global only**, and go directly under the handler's name.
 
 The other options can be used both globally *and* locally, under the `options` key. For example, globally:
 
-```yaml title="mkdocs.yml"
-plugins:
-- mkdocstrings:
-    handlers:
-      github:
-        options:
-          do_something: true
-```
+=== "mkdocs.yaml"
+
+    ```yaml
+    plugins:
+    - mkdocstrings:
+        handlers:
+          github:
+            options:
+              do_something: true
+    ```
+
+=== "zensical.toml"
+
+    ```toml
+    [project.plugins.mkdocstrings.handlers.github.options]
+    do_something = true
+    ```
 
 ...and locally, overriding the global configuration:
 
@@ -138,4 +165,4 @@ These options affect how the documentation is collected from sources and rendere
         show_bases: false
         show_source: false
         show_root_heading: false
-        members: false
+        members: false

{mkdocstrings_github-0.7.2 → mkdocstrings_github-0.8.0}/docs/usage/signatures.md

@@ -155,3 +155,41 @@
             options:
                 signature_version: string
                 signature_version_string: foobar
+
+::: mkdocstrings_handlers.github.config.GitHubOptions.signature_prematter
+    handler: python
+
+??? preview
+
+    === "`signature_prematter: steps:`"
+
+        ::: .github/workflows/example_workflow.yml
+            options:
+                signature_prematter: |
+                  steps:
+
+::: mkdocstrings_handlers.github.config.GitHubOptions.signature_indent
+    handler: python
+
+??? preview
+
+    === "`signature_indent: 4`"
+
+        ::: .github/workflows/example_workflow.yml
+            options:
+                signature_prematter: |
+                  jobs:
+                    example:
+                signature_indent: 4
+
+::: mkdocstrings_handlers.github.config.GitHubOptions.signature_postmatter
+    handler: python
+
+??? preview
+
+    === "`signature_postmatter: permissions: read-all`"
+
+        ::: .github/workflows/example_workflow.yml
+            options:
+                signature_postmatter: |
+                  permissions: read-all