mkdocstrings-matlab 0.9.7__tar.gz → 1.0.1__tar.gz

mkdocstrings_matlab-1.0.1/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: watermarkhu

{mkdocstrings_matlab-0.9.7 → mkdocstrings_matlab-1.0.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@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: "latest"
   

mkdocstrings_matlab-1.0.1/.github/workflows/qualify.yaml

@@ -0,0 +1,165 @@
+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:
+    if: contains(github.event.pull_request.labels.*.name, 'documentation')
+    name: Test deploy documentation
+    uses: ./.github/workflows/docs.yaml
+    concurrency:
+      group: gh-pages
+      cancel-in-progress: false
+    permissions: 
+      contents: write
+    secrets: inherit
+    with:
+      version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
+      alias: ""
+      set-default: false
+      push: true
+
+  setup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      python-versions: ${{ steps.get-versions.outputs.python-versions }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - 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) }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "latest"
+
+    - name: Install dependencies
+      run: |
+        uv sync --all-groups --python ${{ matrix.python-version }}
+
+    - 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 --cov mkdocstrings_handlers.matlab --tb=short -v --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@v4
+      with:
+        name: Test Results (Python ${{ matrix.python-version }})
+        path: pytest.xml
+
+  summary:
+    runs-on: ubuntu-latest
+    needs: [setup, test]
+    if: (!cancelled())
+    permissions:
+      contents: read
+      pull-requests: write
+      checks: write
+    steps:
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        with:
+          files: "artifacts/**/*.xml"
+
+      - 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_matlab-0.9.7 → mkdocstrings_matlab-1.0.1}/.github/workflows/release.yaml

@@ -2,69 +2,23 @@ name: Release
 
 on:
   pull_request:
-    types: [closed]
+    types: 
+      - closed
+      - opened
+      - reopened
+      - synchronize
     branches: [main]
 
-permissions:
-  contents: write
-  id-token: write
-
 jobs:
-  delete-test-document:
-    name: Delete test documentation
-    runs-on: ubuntu-latest
-    if: contains( github.event.pull_request.labels.*.name, 'documentation')
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
 
-    steps:
-      - name: checkout repository
-        uses: actions/checkout@v4
-        with: 
-          fetch-depth: 0 # Required to push to the documentation branch
-
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v5
-        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' }}
-        run: >
-          uv run mike delete 
-          --push --ignore-remote-status 
-          --config-file mkdocs.yml
-          --branch gh-pages
-          $VERSION
-
-  publish:
-    if: github.event.pull_request.merged == true
+  release:
     name: Semantic version release
     runs-on: ubuntu-latest
-    environment: release
     outputs:
       released: ${{ steps.semantic-release.outputs.released }}
       tag: ${{ steps.semantic-release.outputs.tag }}
-    concurrency: release
-    permissions:
-      id-token: write
-      contents: write
 
     steps:
-
     - uses: actions/create-github-app-token@v2
       id: app-token
       with:
@@ -95,7 +49,7 @@ jobs:
 
     - name: Update version and changelogs
       id: semantic-release
-      uses: python-semantic-release/python-semantic-release@v9.21.0
+      uses: python-semantic-release/python-semantic-release@v10
       with: 
         build: false
         changelog: true
@@ -104,37 +58,133 @@ jobs:
         tag: true
         vcs_release: true
         github_token: ${{ steps.app-token.outputs.token }}
+        no_operation_mode: ${{ !github.event.pull_request.merged }}
+
+  comment:
+    name: Create or update comment
+    if: github.event.pull_request.merged == false
+    needs: release
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+    - name: Find Comment
+      id: fc
+      uses: peter-evans/find-comment@v3
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        comment-author: 'github-actions[bot]'
+        body-includes: This comment was written by a bot!
+
+    - name: Create comment
+      if: steps.fc.outputs.comment-id == ''
+      uses: peter-evans/create-or-update-comment@v4
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          Next release: `${{ needs.release.outputs.tag }}`
+          <!-- This comment was written by a bot! -->
+          
+    - name: Update comment
+      if: steps.fc.outputs.comment-id != ''
+      uses: peter-evans/create-or-update-comment@v4
+      with:
+        comment-id: ${{ steps.fc.outputs.comment-id }}
+        edit-mode: replace
+        body: |
+          Next release: `${{ needs.release.outputs.tag }}`
+          <!-- This comment was written by a bot! -->
+
+  deploy: 
+    name: Deploy package distributions
+    needs: release
+    if: needs.release.outputs.released == 'true' && github.event.pull_request.merged
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ needs.release.outputs.tag }}
 
     - name: Install the latest version of uv
-      if: steps.semantic-release.outputs.released == 'true'
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@v6
       with:
         version: "latest"
 
     - name: Build and publish package distributions
-      if: steps.semantic-release.outputs.released == 'true'
       run: |
         uv sync --no-dev
         uv build
         uv publish
 
     - name: Publish package distributions to GitHub Releases
-      if: steps.semantic-release.outputs.released == 'true'
       id: publish-dist
-      uses: python-semantic-release/publish-action@v9.21.0
+      uses: softprops/action-gh-release@v2
       with:
-        github_token: ${{ steps.app-token.outputs.token }}
-        tag: ${{ steps.semantic-release.outputs.tag }}
+        tag_name: ${{ needs.release.outputs.tag }}
+        files: |
+          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@v4
+        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"
 
-  mkdocs:
+      - 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' }}
+        run: >
+          uv run mike delete 
+          --push --ignore-remote-status 
+          --config-file mkdocs.yml
+          --branch gh-pages
+          $VERSION
+
+  document:
     name: Deploy documentation
-    needs: [publish, delete-test-document]
-    if: ${{ always() && !failure() && !cancelled() }}
+    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.publish.outputs.tag }}
+      version: ${{ needs.release.outputs.tag }}
       alias: latest
       set-default: true
-      ref: ${{ needs.publish.outputs.tag }}
+      ref: ${{ needs.release.outputs.tag }}
       push: true

{mkdocstrings_matlab-0.9.7 → mkdocstrings_matlab-1.0.1}/.gitignore

@@ -195,3 +195,5 @@ codegen/
 # Octave session info
 octave-workspace
 
+.vscode/
+.python-version

mkdocstrings_matlab-1.0.1/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+fail_fast: false
+
+repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.3
+    hooks:
+      - id: uv-lock
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-merge-conflict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.8
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+        types_or: [python, pyi]
+        require_serial: true
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.24.1
+    hooks:
+      - id: validate-pyproject
+
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty check
+        entry: uvx ty check . --ignore unresolved-import
+        language: python