fastapi-router-versioning 0.2.2__tar.gz → 0.2.4__tar.gz

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.github/dependabot.yml

@@ -1,5 +1,6 @@
 version: 2
 updates:
+  # GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
@@ -7,14 +8,16 @@ updates:
     cooldown:
       default-days: 7
     commit-message:
-      prefix: "chore(actions)"
+      prefix: ⬆
     labels:
+      - "internal"
       - "dependencies"
+      - "github_actions"
     groups:
       github-actions:
         patterns:
           - "*"
-
+  # Python
   - package-ecosystem: "uv"
     directory: "/"
     schedule:
@@ -22,13 +25,13 @@ updates:
     cooldown:
       default-days: 7
     commit-message:
-      prefix: "chore(deps)"
+      prefix: ⬆
     groups:
-      python-dev:
+      python-packages:
         dependency-type: "development"
         patterns:
           - "*"
-
+  # pre-commit
   - package-ecosystem: "pre-commit"
     directory: "/"
     schedule:
@@ -36,9 +39,11 @@ updates:
     cooldown:
       default-days: 7
     commit-message:
-      prefix: "chore(pre-commit)"
+      prefix: ⬆
     labels:
+      - "internal"
       - "dependencies"
+      - "pre-commit"
     groups:
       pre-commit:
         patterns:

fastapi_router_versioning-0.2.4/.github/labeler.yml

@@ -0,0 +1,22 @@
+docs:
+  - all:
+    - changed-files:
+      - any-glob-to-any-file:
+        - README.md
+        - RELEASE_NOTES.md
+      - all-globs-to-all-files:
+        - '!fastapi_router_versioning/**'
+        - '!pyproject.toml'
+
+internal:
+  - all:
+    - changed-files:
+      - any-glob-to-any-file:
+        - .github/**
+        - scripts/**
+        - .gitignore
+        - .pre-commit-config.yaml
+        - uv.lock
+      - all-globs-to-all-files:
+        - '!fastapi_router_versioning/**'
+        - '!pyproject.toml'

fastapi_router_versioning-0.2.4/.github/workflows/create-draft-release.yml

@@ -0,0 +1,56 @@
+name: Create Draft Release
+
+on:
+  pull_request:
+    types:
+      - closed
+
+permissions: {}
+
+jobs:
+  create-draft-release:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release')
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    env:
+      PREPARE_RELEASE_VERSION_FILE: fastapi_router_versioning/__init__.py
+      PREPARE_RELEASE_RELEASE_NOTES_FILE: RELEASE_NOTES.md
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+          persist-credentials: true
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version-file: ".python-version"
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          # Before upgrading uv version, make sure astral-sh/setup-uv knows its checksum.
+          # See: https://github.com/astral-sh/setup-uv/issues/851#issuecomment-4282017837
+          version: "0.11.18"
+      - name: Extract release details
+        id: release-details
+        run: |
+          set -euo pipefail
+          version="$(uv run python scripts/prepare_release.py current-version)"
+          uv run python scripts/prepare_release.py release-notes > draft-release-notes.md
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+      - name: Create draft release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ steps.release-details.outputs.version }}
+        run: |
+          set -euo pipefail
+          gh release create "$VERSION" \
+            --draft \
+            --title "$VERSION" \
+            --notes-file draft-release-notes.md \
+            --target "$(git rev-parse HEAD)"

fastapi_router_versioning-0.2.4/.github/workflows/guard-dependencies.yml

@@ -0,0 +1,53 @@
+name: Guard Dependencies
+
+on:
+  pull_request_target: # zizmor: ignore[dangerous-triggers] -- This workflow only reads context.payload metadata, never checks out PR code
+    branches: [main]
+    paths:
+      - pyproject.toml
+      - uv.lock
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+jobs:
+  check-author:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Check if author is org member or allowed bot
+        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
+        with:
+          script: |
+            const pr = context.payload.pull_request;
+            const author = pr.user.login;
+            const assoc = pr.author_association;
+
+            const botAllowlist = new Set(['dependabot[bot]']);
+            const orgAuthorAssociations = new Set(['MEMBER', 'OWNER']);
+
+            const allowed =
+              botAllowlist.has(author) ||
+              (assoc != null && orgAuthorAssociations.has(assoc));
+
+            if (!allowed) {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.payload.pull_request.number,
+                body: `This PR modifies dependency files (\`pyproject.toml\` or \`uv.lock\`), which is restricted to members of the **${context.repo.owner}** organization on GitHub.\n\nIf you need a dependency change, please [open a discussion](https://github.com/${context.repo.owner}/${context.repo.repo}/discussions/new) describing what you need and why.\n\nClosing this PR automatically.`
+              });
+
+              await github.rest.pulls.update({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: context.payload.pull_request.number,
+                state: 'closed'
+              });
+
+              core.setFailed('Dependency changes are restricted to organization members.');
+            } else {
+              console.log(`Author ${author} (author_association=${assoc}) is allowed to make dependency changes.`);
+            }

fastapi_router_versioning-0.2.4/.github/workflows/labeler.yml

@@ -0,0 +1,37 @@
+name: Labels
+on:
+  pull_request_target: # zizmor: ignore[dangerous-triggers]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      # For label-checker
+      - labeled
+      - unlabeled
+
+permissions: {}
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+    - uses: actions/labeler@f27b608878404679385c85cfa523b85ccb86e213 # v6.1.0
+      if: ${{ github.event.action != 'labeled' && github.event.action != 'unlabeled' }}
+    - run: echo "Done adding labels"
+  # Run this after labeler applied labels
+  check-labels:
+    needs:
+      - labeler
+    permissions:
+      pull-requests: read
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: agilepathway/label-checker@c3d16ad512e7cea5961df85ff2486bb774caf3c5 # v1.6.65
+        with:
+          one_of: breaking,security,feature,bug,refactor,upgrade,docs,internal,release
+          repo_token: ${{ secrets.GITHUB_TOKEN }}

fastapi_router_versioning-0.2.4/.github/workflows/latest-changes.yml

@@ -0,0 +1,50 @@
+name: Latest Changes
+
+on:
+  pull_request_target: # zizmor: ignore[dangerous-triggers]
+    branches:
+      - main
+    types:
+      - closed
+  workflow_dispatch:
+    inputs:
+      number:
+        description: PR number
+        required: true
+      debug_enabled:
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: 'false'
+
+permissions: {}
+
+jobs:
+  latest-changes:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.merged == true
+    timeout-minutes: 5
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+          # To allow latest-changes to commit to the main branch
+          token: ${{ secrets.FASTAPI_ROUTER_VERSIONING_LATEST_CHANGES }}  # zizmor: ignore[secrets-outside-env]
+          persist-credentials: true # required by tiangolo/latest-changes
+      # Allow debugging with tmate
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@35b54afac29c97fb54faba5b513f8fbd1882f113 # v3.24
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
+        with:
+          limit-access-to-actor: true
+      - uses: tiangolo/latest-changes@c9b73efbc8992ef1a401e4235ea307a8ca8a724b # 0.6.1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          latest_changes_file: RELEASE_NOTES.md
+          latest_changes_header: '## Latest Changes'
+          end_regex: '^## '
+          debug_logs: true
+          label_header_prefix: '### '

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.github/workflows/pre-commit.yml

@@ -2,9 +2,6 @@ name: pre-commit
 
 on:
   pull_request:
-    types:
-      - opened
-      - synchronize
 
 permissions: {}
 
@@ -28,13 +25,15 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version-file: ".python-version"
 
       - name: Setup uv
         uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
+          # Before upgrading uv version, make sure astral-sh/setup-uv knows its checksum.
+          # See: https://github.com/astral-sh/setup-uv/issues/851#issuecomment-4282017837
           version: "0.11.18"
           cache-dependency-glob: |
             pyproject.toml
@@ -47,8 +46,8 @@ jobs:
         # Only lint files changed in this PR, not the entire repo
         run: uv run prek run --from-ref origin/${GITHUB_BASE_REF} --to-ref HEAD --show-diff-on-failure
 
-  # Required by GitHub branch protection rules
-  pre-commit-alls-green:
+  # https://github.com/marketplace/actions/alls-green#why
+  pre-commit-alls-green:  # This job does nothing and is only used for the branch protection
     if: always()
     needs:
       - pre-commit

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.github/workflows/prepare-release.yml

@@ -18,10 +18,6 @@ on:
 
 permissions: {}
 
-env:
-  PREPARE_RELEASE_VERSION_FILE: fastapi_router_versioning/__init__.py
-  PREPARE_RELEASE_RELEASE_NOTES_FILE: RELEASE_NOTES.md
-
 jobs:
   prepare-release:
     runs-on: ubuntu-latest
@@ -30,12 +26,20 @@ jobs:
       contents: write
       issues: write
       pull-requests: write
+    env:
+      PREPARE_RELEASE_VERSION_FILE: fastapi_router_versioning/__init__.py
+      PREPARE_RELEASE_RELEASE_NOTES_FILE: RELEASE_NOTES.md
     steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
       - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
+          token: ${{ secrets.FASTAPI_ROUTER_VERSIONING_LATEST_CHANGES }} # zizmor: ignore[secrets-outside-env]
           persist-credentials: true
       - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version-file: ".python-version"
       - name: Install uv
@@ -62,7 +66,7 @@ jobs:
           gh label create release --color 0075ca --description "Release PR" 2>/dev/null || true
       - name: Create release pull request
         env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ secrets.FASTAPI_ROUTER_VERSIONING_LATEST_CHANGES }}
           VERSION: ${{ steps.release-version.outputs.version }}
         run: |
           set -euo pipefail

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.github/workflows/publish.yml

@@ -24,7 +24,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version-file: ".python-version"
       - name: Install uv

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.github/workflows/test-redistribute.yml

@@ -5,9 +5,6 @@ on:
     branches:
       - main
   pull_request:
-    types:
-      - opened
-      - synchronize
 
 permissions: {}
 
@@ -15,6 +12,7 @@ jobs:
   changes:
     runs-on: ubuntu-latest
     permissions:
+      contents: read
       pull-requests: read
     timeout-minutes: 5
     outputs:
@@ -23,7 +21,7 @@ jobs:
       - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           persist-credentials: false
-      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
+      - uses: dorny/paths-filter@7b450fff21473bca461d4b92ce414b9d0420d706 # v4.0.2
         id: filter
         with:
           filters: |
@@ -52,7 +50,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version-file: ".python-version"
       - name: Install build dependencies
@@ -77,7 +75,7 @@ jobs:
           pip wheel --no-deps fastapi_router_versioning*.tar.gz
 
   # https://github.com/marketplace/actions/alls-green#why
-  test-redistribute-alls-green:
+  test-redistribute-alls-green:  # This job does nothing and is only used for the branch protection
     if: always()
     needs:
       - test-redistribute

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.github/workflows/test.yml

@@ -5,10 +5,8 @@ on:
     branches:
       - main
   pull_request:
-    types:
-      - opened
-      - synchronize
   schedule:
+    # cron every week on monday
     - cron: "0 0 * * 1"
 
 permissions: {}
@@ -19,16 +17,20 @@ env:
 jobs:
   changes:
     runs-on: ubuntu-latest
+    # Required permissions
     permissions:
+      contents: read
       pull-requests: read
     timeout-minutes: 5
+    # Set job outputs to values from filter step
     outputs:
       src: ${{ steps.filter.outputs.src }}
     steps:
       - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           persist-credentials: false
-      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
+      # For pull requests it's not necessary to checkout the code but for the main branch it is
+      - uses: dorny/paths-filter@7b450fff21473bca461d4b92ce414b9d0420d706 # v4.0.2
         id: filter
         with:
           filters: |
@@ -75,21 +77,23 @@ jobs:
           persist-credentials: false
 
       - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Setup uv
         uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
+          # Before upgrading uv version, make sure astral-sh/setup-uv knows its checksum.
+          # See: https://github.com/astral-sh/setup-uv/issues/851#issuecomment-4282017837
           version: "0.11.18"
           enable-cache: true
-          cache-suffix: ${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.uv-resolution }}-fa${{ matrix.fastapi-version }}
+          cache-suffix: ${{ matrix.python-version }}-fa${{ matrix.fastapi-version }}
           cache-dependency-glob: |
             pyproject.toml
             uv.lock
 
-      - name: Install dependencies
+      - name: Install Dependencies
         run: uv sync
 
       - name: Override FastAPI version
@@ -100,17 +104,16 @@ jobs:
         run: mkdir coverage
 
       - name: Test
-        # GitHub Windows runners ship bash natively
-        run: uv run --no-sync bash scripts/test.sh
+        run: uv run --no-sync bash scripts/test-cov.sh
         env:
-          COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-fa${{ matrix.fastapi-version }}
-          CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}-fa${{ matrix.fastapi-version }}
+          COVERAGE_FILE: coverage/.coverage.py${{ matrix.python-version }}-fa${{ matrix.fastapi-version }}
+          CONTEXT: py${{ matrix.python-version }}-fa${{ matrix.fastapi-version }}
 
       - name: Store coverage files
         if: matrix.coverage == 'coverage'
         uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
-          name: coverage-${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.fastapi-version }}
+          name: coverage-${{ matrix.python-version }}-${{ matrix.fastapi-version }}
           path: coverage
           include-hidden-files: true
 
@@ -122,6 +125,11 @@ jobs:
     permissions:
       contents: read
     steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+
       - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           persist-credentials: false
@@ -129,6 +137,8 @@ jobs:
       - name: Setup uv
         uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
+          # Before upgrading uv version, make sure astral-sh/setup-uv knows its checksum.
+          # See: https://github.com/astral-sh/setup-uv/issues/851#issuecomment-4282017837
           version: "0.11.18"
           enable-cache: true
           cache-dependency-glob: |
@@ -148,6 +158,7 @@ jobs:
       - run: ls -la coverage
       - run: uv run coverage combine coverage
       - run: uv run coverage html --title "Coverage for ${{ github.sha }}"
+      - run: uv run coverage xml
 
       - name: Store coverage HTML
         uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
@@ -156,17 +167,28 @@ jobs:
           path: htmlcov
           include-hidden-files: true
 
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          fail_ci_if_error: true
+
       - run: uv run coverage report --fail-under=100
 
-  check:
+  # https://github.com/marketplace/actions/alls-green#why
+  test-alls-green:  # This job does nothing and is only used for the branch protection
     if: always()
     needs:
       - test
       - coverage-combine
     runs-on: ubuntu-latest
     timeout-minutes: 5
-    permissions: {}
     steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
       - name: Decide whether the needed jobs succeeded or failed
         uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
         with:

fastapi_router_versioning-0.2.4/.github/workflows/zizmor.yml

@@ -0,0 +1,25 @@
+name: Zizmor
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions: {}
+
+jobs:
+  zizmor:
+    name: Run zizmor
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      security-events: write # Required for upload-sarif (used by zizmor-action) to upload SARIF files.
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+      - name: Run zizmor
+        uses: zizmorcore/zizmor-action@192e21d79ab29983730a13d1382995c2307fbcaa # v0.5.7

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
     rev: b859c0df7f391deba73030f79b957e62b4d81dc6 # varcon-core-v5.0.7
     hooks:
       - id: typos
-        args: [--force-exclude]
+        args: [ --force-exclude ]
 
   - repo: local
     hooks:
@@ -54,6 +54,6 @@ repos:
         name: zizmor
         language: python
         entry: uv run zizmor .
-        files: ^\.github/workflows/
+        files: ^\.github/workflows/|^uv\.lock$
         require_serial: true
         pass_filenames: false

{fastapi_router_versioning-0.2.2 → fastapi_router_versioning-0.2.4}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Sebastián Ramírez
+Copyright (c) 2026 Matteo Nieddu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal