mkdocstrings-github 0.1.0__tar.gz

mkdocstrings_github-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @watermarkhu

mkdocstrings_github-0.1.0/.github/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to mkdocstrings-matlab
+
+Thank you for considering contributing! Please follow these steps to get started:
+
+## 1. Environment Setup
+
+Install all dependencies using [uv](https://github.com/astral-sh/uv):
+
+```sh
+uv sync --all-groups
+```
+
+Learn more about uv: [uv documentation](https://github.com/astral-sh/uv)
+
+## 2. Pre-commit Hooks using prek
+
+Set up [prek](https://github.com/j178/prek) hooks to ensure code quality:
+
+```sh
+uv run prek install
+```
+
+See: [prek documentation](https://prek.j178.dev/)
+
+## 3. Running Tests
+
+Run tests with [pytest](https://docs.pytest.org/en/stable/):
+
+```sh
+uv run pytest
+```
+
+See: [pytest documentation](https://docs.pytest.org/en/stable/)
+
+## 4. Pull Request Guidelines
+
+- Pull requests should target the `main` branch.
+- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
+
+See: [Conventional Commits Spec](https://www.conventionalcommits.org/en/v1.0.0/)

mkdocstrings_github-0.1.0/.github/FUNDING.yml

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

mkdocstrings_github-0.1.0/.github/renovate.json5

@@ -0,0 +1,85 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  extends: [
+    "config:recommended",
+  ],
+  automerge: true,
+  semanticCommits: "enabled",
+  branchPrefix: "renovate-",
+  packageRules: [
+    {
+      groupName: "group-github-actions",
+      description: "Group GitHub Action updates",
+      matchManagers: [
+        "github-actions",
+      ],
+      semanticCommitType: "ci",
+      semanticCommitScope: "deps",
+    },
+    {
+      groupName: "group-pre-commit",
+      description: "Group pre-commit hook updates",
+      matchManagers: [
+        "pre-commit",
+      ],
+      semanticCommitType: "build",
+      semanticCommitScope: "deps",
+    },
+    {
+      // This handles all non-dev, non-doc dependencies in pyproject.toml
+      groupName: "group-pyproject",
+      description: "Group dependency updates from pyproject.toml",
+      matchFileNames: [
+        "pyproject.toml",
+      ],
+      semanticCommitType: "chore",
+      semanticCommitScope: "deps",
+    },
+    {
+      // This handles dev dependencies in pyproject.toml
+      groupName: "group-pyproject-dev",
+      description: "Group dev dependency updates from pyproject.toml",
+      matchFileNames: [
+        "pyproject.toml",
+      ],
+      matchPackageNames: [
+        "ty",
+        "prek",
+        "ruff",
+        "pydantic",
+        "pytest",
+        "pytest-cov",
+        "beautifulsoup4",
+        "inline-snapshot",
+        "python-semantic-release",
+      ],
+      semanticCommitType: "build",
+      semanticCommitScope: "deps",
+    },
+    {
+      // This handles documentation-related dependencies in pyproject.toml
+      groupName: "group-pyproject-docs",
+      description: "Group docs dependency updates from pyproject.toml",
+      matchFileNames: [
+        "pyproject.toml",
+      ],
+      matchPackageNames: [
+        "mkdocs-material",
+        "markdown-exec",
+        "mkdocs-callouts",
+        "mkdocs-git-revision-date-localized-plugin",
+        "mkdocs-minify-plugin",
+        "mike",
+      ],
+      semanticCommitType: "docs",
+      semanticCommitScope: "deps",
+    },
+  ],
+  "pre-commit": {
+    enabled: true,
+  },
+  // Disable poetry and let the PEP621 manager handle pyproject.toml
+  "poetry": {
+    "enabled": false
+  }
+}

mkdocstrings_github-0.1.0/.github/workflows/docs.yaml

@@ -0,0 +1,76 @@
+name: Docs
+
+# Controls when the workflow will run
+on:
+  workflow_call:
+    inputs:
+      version:
+        description: >-
+          Version of the documentation to publish
+        type: string
+        required: true
+      alias:
+        description: >-
+          (Versioned) Alias to use when publishing the versioned documentation with mike
+        type: string
+        default: "latest"
+      set-default:
+        description: >-
+          Set the alias as the default version
+        type: boolean
+        default: true
+      ref:
+        description: >-
+          The ref to checkout and use to create docs
+        type: string
+        default: ""
+      push:
+        description: >-
+          Push the documentation to the remote branch
+        type: boolean
+        default: true
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # Required to push to the documentation branch
+          ref: ${{ inputs.ref }} 
+
+      - 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
+  
+      - name: Build documentation with mike
+        env:
+          PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
+        run: >
+          uv run mike deploy ${PUSH_DEPLOY}
+          --update-aliases
+          --branch gh-pages
+          --alias-type symlink
+          ${{ 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
+          ${{ inputs.alias }}

mkdocstrings_github-0.1.0/.github/workflows/example_workflow.yml

@@ -0,0 +1,133 @@
+name: 'Example workflow'
+description: "This key is illegal but will still be parsed"
+
+on:
+  workflow_call:
+    inputs:
+      environment:
+        description: 'Environment to deploy to'
+        required: true
+        type: string
+      version:
+        description: 'Version to deploy'
+        required: false
+        type: string
+        default: 'latest'
+      enable-notifications:
+        description: 'Whether to send notifications'
+        required: false
+        type: boolean
+        default: false
+      parallel-jobs:
+        description: 'Number of parallel jobs'
+        required: false
+        type: number
+        default: 1
+      configuration:
+        description: 'JSON configuration object'
+        required: false
+        type: string
+        default: '{}'
+    secrets:
+      API_KEY:
+        description: 'API key for external service'
+        required: true
+      DATABASE_URL:
+        description: 'Database connection string'
+        required: false
+      SLACK_WEBHOOK:
+        description: 'Slack webhook URL for notifications'
+        required: false
+    outputs:
+      deployment-id:
+        description: 'ID of the created deployment'
+        value: ${{ jobs.deploy.outputs.deployment-id }}
+      deployment-url:
+        description: 'URL of the deployment'
+        value: ${{ jobs.deploy.outputs.deployment-url }}
+      success:
+        description: 'Whether the deployment was successful'
+        value: ${{ jobs.deploy.outputs.success }}
+
+permissions:
+  contents: read
+  deployments: write
+  pull-requests: write
+  issues: read
+
+env:
+  DEPLOYMENT_ENVIRONMENT: ${{ inputs.environment }}
+  ENABLE_DEBUG: false
+
+jobs:
+  validate:
+    name: 'Validate Inputs'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Validate environment
+        run: |
+          echo "Validating environment: ${{ inputs.environment }}"
+          if [[ ! "${{ inputs.environment }}" =~ ^(development|staging|production)$ ]]; then
+            echo "Error: Invalid environment specified"
+            exit 1
+          fi
+          
+      - name: Validate version
+        run: |
+          echo "Validating version: ${{ inputs.version }}"
+          
+      - name: Check secrets
+        run: |
+          if [[ -z "${{ secrets.API_KEY }}" ]]; then
+            echo "Error: API_KEY secret is required"
+            exit 1
+          fi
+          echo "All required secrets are available"
+
+  deploy:
+    name: 'Deploy Application'
+    runs-on: ubuntu-latest
+    needs: validate
+    outputs:
+      deployment-id: ${{ steps.deploy.outputs.deployment-id }}
+      deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+      success: ${{ steps.deploy.outputs.success }}
+    steps:
+      - name: Setup deployment
+        run: |
+          echo "Setting up deployment for ${{ inputs.environment }}"
+          echo "Version: ${{ inputs.version }}"
+          echo "Parallel jobs: ${{ inputs.parallel-jobs }}"
+          echo "Notifications enabled: ${{ inputs.enable-notifications }}"
+          
+      - name: Parse configuration
+        run: |
+          echo "Configuration: ${{ inputs.configuration }}"
+          
+      - name: Execute deployment
+        id: deploy
+        run: |
+          deployment_id="reusable-deploy-$(date +%s)"
+          deployment_url="https://${{ inputs.environment }}.example.com"
+          
+          echo "deployment-id=${deployment_id}" >> $GITHUB_OUTPUT
+          echo "deployment-url=${deployment_url}" >> $GITHUB_OUTPUT
+          echo "success=true" >> $GITHUB_OUTPUT
+          
+          echo "Deployment completed successfully"
+          echo "ID: ${deployment_id}"
+          echo "URL: ${deployment_url}"
+
+  notify:
+    name: 'Send Notifications'
+    runs-on: ubuntu-latest
+    needs: deploy
+    if: ${{ inputs.enable-notifications }}
+    steps:
+      - name: Send Slack notification
+        run: |
+          echo "Sending Slack notification about deployment ${{ needs.deploy.outputs.deployment-id }}"
+          
+      - name: Create GitHub deployment
+        run: |
+          echo "Creating GitHub deployment status for ${{ needs.deploy.outputs.deployment-id }}"

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

@@ -0,0 +1,167 @@
+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@v5
+    
+    - 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@v5
+      with:
+        submodules: true
+
+    - 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.github --tb=short -v --junit-xml=pytest.xml --color=yes; 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@v5
+        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