mkdocs-metadata-enricher-plugin 0.2.1__tar.gz

mkdocs_metadata_enricher_plugin-0.2.1/.github/dependabot.yml

@@ -0,0 +1,27 @@
+# Dependabot configuration for automated dependency updates
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates
+
+version: 2
+updates:
+  # Python dependencies (pip ecosystem for pyproject.toml)
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "chore(deps)"
+
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "ci(deps)"

mkdocs_metadata_enricher_plugin-0.2.1/.github/workflows/ci.yml

@@ -0,0 +1,107 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0  # Full history for git operations
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest --cov=src/mkdocs_metadata_enricher --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5
+        if: matrix.python-version == '3.12'
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+          flags: unittests
+          name: codecov-umbrella
+
+  lint:
+    name: Lint and Format
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run ruff check
+        run: uv run ruff check .
+
+      - name: Run ruff format check
+        run: uv run ruff format --check .
+
+  type-check:
+    name: Type Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run ty type checker
+        run: uvx ty check src/
+
+  build:
+    name: Build Package
+    runs-on: ubuntu-latest
+    needs: [test, lint, type-check]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v6
+        with:
+          name: dist
+          path: dist/

mkdocs_metadata_enricher_plugin-0.2.1/.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0  # Full history for git-revision-date-localized
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install docs dependencies
+        run: uv sync --group docs
+
+      - name: Deploy to GitHub Pages
+        run: uv run mkdocs gh-deploy --force

mkdocs_metadata_enricher_plugin-0.2.1/.github/workflows/prepare-release.yml

@@ -0,0 +1,81 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: 'Bumping strategy (major, minor, patch)'
+        required: true
+        default: 'patch'
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install git-cliff
+        uses: kenji-miyake/setup-git-cliff@v2
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Get current version
+        id: current_version
+        run: |
+          VERSION=$(grep -oP '__version__ = "\K[^"]+' src/mkdocs_metadata_enricher_plugin/__init__.py)
+          echo "current_version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Determine next version
+        id: next_version
+        run: |
+          # Use git-cliff to bump version based on commits or use the input bump
+          # If we want it fully automatic based on commits:
+          # NEXT_VERSION=$(git cliff --bump --version-only)
+          # For more control, we use the input:
+          CURRENT_VERSION=${{ steps.current_version.outputs.current_version }}
+          IFS='.' read -r major minor patch <<< "$CURRENT_VERSION"
+          if [ "${{ github.event.inputs.bump }}" == "major" ]; then
+            NEXT_VERSION="$((major + 1)).0.0"
+          elif [ "${{ github.event.inputs.bump }}" == "minor" ]; then
+            NEXT_VERSION="$major.$((minor + 1)).0"
+          else
+            NEXT_VERSION="$major.$minor.$((patch + 1))"
+          fi
+          echo "next_version=$NEXT_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Update version in code
+        run: |
+          sed -i "s/__version__ = \".*\"/__version__ = \"${{ steps.next_version.outputs.next_version }}\"/" src/mkdocs_metadata_enricher_plugin/__init__.py
+
+      - name: Update Changelog
+        run: |
+          git cliff --tag v${{ steps.next_version.outputs.next_version }} --output CHANGELOG.md
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "chore(release): prepare for v${{ steps.next_version.outputs.next_version }}"
+          branch: "release/v${{ steps.next_version.outputs.next_version }}"
+          title: "release: v${{ steps.next_version.outputs.next_version }}"
+          body: |
+            Automated release preparation for v${{ steps.next_version.outputs.next_version }}.
+
+            This PR:
+            - Bumps version to v${{ steps.next_version.outputs.next_version }}
+            - Updates `CHANGELOG.md`
+
+            Merge this PR to trigger a new release.
+          labels: release

mkdocs_metadata_enricher_plugin-0.2.1/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+
+permissions:
+  contents: write
+  id-token: write # Required for PyPI OIDC
+
+jobs:
+  release:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Extract version
+        id: extract_version
+        run: |
+          # Extract version from PR title (e.g., "release: v0.2.0")
+          VERSION=$(echo "${{ github.event.pull_request.title }}" | grep -oP 'v\K[0-9.]+')
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Create and push tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag "v${{ steps.extract_version.outputs.version }}"
+          git push origin "v${{ steps.extract_version.outputs.version }}"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

mkdocs_metadata_enricher_plugin-0.2.1/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# UV package manager
+.uv/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store

mkdocs_metadata_enricher_plugin-0.2.1/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.1
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+        args: [--maxkb=1000]

mkdocs_metadata_enricher_plugin-0.2.1/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.2.1] - 2026-02-16
+
+### Miscellaneous Tasks
+
+- *(release)* Consolidate tagging and publishing workflows
+
+## [0.2.0] - 2026-02-16
+
+### Documentation
+
+- Replace placeholder URLs with actual org name
+
+### Features
+
+- *(docs)* Add GitHub Pages demo site with mkdocs-material
+- *(ci)* Automate release process with git-cliff and GitHub Actions
+
+### Fixed
+
+- Fix CI/CD workflow bugs
+- Update PyPI URL in publish workflow to match renamed package
+- *(docs)* User standard material icon for logo
+- Use strict ISO 8601 format for git dates to support Python 3.9/3.10
+- *(plugin)* Use full git commit time precision in search index
+
+### Miscellaneous Tasks
+
+- Remove uv.lock from .gitignore
+- Add ty type checker to CI
+- Add project.urls, Python 3.13 support, bump pre-commit
+- Add Dependabot configuration
+- *(deps)* Bump actions/checkout from 4 to 6
+- *(deps)* Bump astral-sh/setup-uv from 5 to 7
+- *(deps)* Bump actions/download-artifact from 4 to 7
+- *(deps)* Bump actions/upload-artifact from 4 to 6
+- *(deps)* Bump codecov/codecov-action from 3 to 5
+
+### Performance
+
+- Cache git dates and use path mapping in on_post_build
+
+### Refactor
+
+- Rename package to mkdocs-metadata-enricher-plugin
+- Replace pytz with stdlib zoneinfo
+- Narrow exception handling and modernize annotations
+
+### Styling
+
+- *(docs)* Enhance demo site aesthetics and add .nojekyll
+
+### Testing
+
+- Enable integration test and add edge case tests
+- Fix mock patch location and add path normalization for search index
+
+<!-- generated by git-cliff -->