fastapi-router-versioning 1.0.0__tar.gz → 1.0.2__tar.gz

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/labeler.yml

@@ -3,7 +3,7 @@ docs:
     - changed-files:
       - any-glob-to-any-file:
         - README.md
-        - RELEASE_NOTES.md
+        - release-notes.md
       - all-globs-to-all-files:
         - '!fastapi_router_versioning/**'
         - '!pyproject.toml'

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/bump-pre-commit-hooks.yml

@@ -17,16 +17,15 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
-          token: ${{ secrets.FASTAPI_ROUTER_VERSIONING_LATEST_CHANGES }}
-          persist-credentials: true
+          persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version-file: ".python-version"
       - name: Setup uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv
         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
@@ -52,6 +51,7 @@ jobs:
           git switch -C "$branch"
           git add .pre-commit-config.yaml
           git commit -m "⬆ Bump pre-commit hooks"
+          gh auth setup-git
           git push --force origin "$branch"
           if [ -z "$(gh pr list --head "$branch" --state open --json number --jq '.[].number')" ]; then
             gh pr create \

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/create-draft-release.yml

@@ -16,22 +16,22 @@ jobs:
       contents: write
     env:
       PREPARE_RELEASE_VERSION_FILE: fastapi_router_versioning/__init__.py
-      PREPARE_RELEASE_RELEASE_NOTES_FILE: RELEASE_NOTES.md
+      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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
           ref: ${{ github.event.repository.default_branch }}
-          persist-credentials: true
+          persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version-file: ".python-version"
       - name: Install uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv
         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

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/detect-conflicts.yml

@@ -15,7 +15,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: Check if PRs have merge conflicts
-        uses: eps1lon/actions-label-merge-conflict@0273be72a0bbd58fcd71d0d6c02c209b50d1e5e1 # v3.1.0
+        uses: eps1lon/actions-label-merge-conflict@0273be72a0bbd58fcd71d0d6c02c209b50d1e5e1 # v3.1.0 #sync-pin:actions-label-merge-conflict
         with:
           dirtyLabel: "conflicts"
           repoToken: "${{ secrets.GITHUB_TOKEN }}"

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/guard-dependencies.yml

@@ -18,7 +18,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: Check if author is org member or allowed bot
-        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
+        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 #sync-pin:github-script
         with:
           script: |
             const pr = context.payload.pull_request;

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

@@ -0,0 +1,20 @@
+name: Labels
+on:
+  pull_request_target: # zizmor: ignore[dangerous-triggers]
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+permissions: {}
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+    - uses: actions/labeler@bf12e9b00b37c5c0ca2b87b79b2daf7891dbda13 # v7.0.0 #sync-pin:labeler
+    - run: echo "Done adding labels"

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/pre-commit.yml

@@ -18,19 +18,19 @@ jobs:
         run: echo "$GITHUB_CONTEXT"
 
       - name: Checkout code
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
           persist-credentials: false
           # Full history required for --from-ref/--to-ref diff in prek
           fetch-depth: 0
 
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version-file: ".python-version"
 
       - name: Setup uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv
         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
@@ -60,6 +60,6 @@ jobs:
         run: echo "$GITHUB_CONTEXT"
 
       - name: Decide whether the needed jobs succeeded or failed
-        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
+        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2 #sync-pin:alls-green
         with:
           jobs: ${{ toJSON(needs) }}

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/prepare-release.yml

@@ -28,22 +28,21 @@ jobs:
       pull-requests: write
     env:
       PREPARE_RELEASE_VERSION_FILE: fastapi_router_versioning/__init__.py
-      PREPARE_RELEASE_RELEASE_NOTES_FILE: RELEASE_NOTES.md
+      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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
-          token: ${{ secrets.FASTAPI_ROUTER_VERSIONING_LATEST_CHANGES }} # zizmor: ignore[secrets-outside-env]
-          persist-credentials: true
+          persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version-file: ".python-version"
       - name: Install uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv
         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
@@ -76,6 +75,7 @@ jobs:
           git switch -c "$branch"
           git add $PREPARE_RELEASE_VERSION_FILE $PREPARE_RELEASE_RELEASE_NOTES_FILE
           git commit -m "🔖 Release version ${VERSION}"
+          gh auth setup-git
           git push --set-upstream origin "$branch"
           gh pr create \
             --base main \

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/publish.yml

@@ -20,15 +20,15 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
           persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version-file: ".python-version"
       - name: Install uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv
         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

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/test-redistribute.yml

@@ -18,10 +18,10 @@ jobs:
     outputs:
       src: ${{ steps.filter.outputs.src }}
     steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
           persist-credentials: false
-      - uses: dorny/paths-filter@7b450fff21473bca461d4b92ce414b9d0420d706 # v4.0.2
+      - uses: dorny/paths-filter@7b450fff21473bca461d4b92ce414b9d0420d706 # v4.0.2 #sync-pin:paths-filter
         id: filter
         with:
           filters: |
@@ -46,11 +46,11 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout-2
         with:
           persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version-file: ".python-version"
       - name: Install build dependencies
@@ -83,7 +83,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: Decide whether the needed jobs succeeded or failed
-        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
+        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2 #sync-pin:alls-green
         with:
           jobs: ${{ toJSON(needs) }}
           allowed-skips: test-redistribute

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/test.yml

@@ -19,23 +19,23 @@ jobs:
     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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
           persist-credentials: false
       # 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
+      - uses: dorny/paths-filter@7b450fff21473bca461d4b92ce414b9d0420d706 # v4.0.2 #sync-pin:paths-filter
         id: filter
         with:
           filters: |
             src:
               - .github/workflows/test.yml
+              - examples/**
               - fastapi_router_versioning/**
               - scripts/**
               - tests/**
@@ -48,8 +48,6 @@ jobs:
       - changes
     if: needs.changes.outputs.src == 'true' || github.ref == 'refs/heads/main'
     timeout-minutes: 15
-    permissions:
-      contents: read
     strategy:
       fail-fast: false
       matrix:
@@ -72,17 +70,17 @@ jobs:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
 
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout-2
         with:
           persist-credentials: false
 
       - name: Set up Python
-        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Setup uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv
         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
@@ -104,6 +102,7 @@ jobs:
         run: mkdir coverage
 
       - name: Test
+        # GitHub Windows runners ship bash natively
         run: uv run --no-sync bash scripts/test-cov.sh
         env:
           COVERAGE_FILE: coverage/.coverage.py${{ matrix.python-version }}-fa${{ matrix.fastapi-version }}
@@ -111,31 +110,107 @@ jobs:
 
       - name: Store coverage files
         if: matrix.coverage == 'coverage'
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 #sync-pin:upload-artifact
         with:
           name: coverage-${{ matrix.python-version }}-${{ matrix.fastapi-version }}
           path: coverage
           include-hidden-files: true
 
+  regression-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check out the pull request
+        if: github.event_name == 'pull_request'
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout-3
+        with:
+          ref: ${{ github.sha }}
+          path: pr
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Find changed tests
+        if: github.event_name == 'pull_request'
+        id: changed-tests
+        working-directory: pr
+        env:
+          BASE_SHA: ${{ github.event.pull_request.base.sha }}
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+        run: |
+          git diff --name-only --diff-filter=AM -z "$BASE_SHA" "$HEAD_SHA" -- tests \
+            | while IFS= read -r -d '' file; do
+                case "$(basename "$file")" in
+                  test_*.py) printf '%s\0' "$file" ;;
+                esac
+              done > "$RUNNER_TEMP/changed-tests"
+          if [ -s "$RUNNER_TEMP/changed-tests" ]; then
+            echo "found=true" >> "$GITHUB_OUTPUT"
+            git diff --binary "$BASE_SHA" "$HEAD_SHA" -- tests \
+              > "$RUNNER_TEMP/tests.patch"
+          else
+            echo "found=false" >> "$GITHUB_OUTPUT"
+            echo "No added or modified test files; regression proof is not applicable."
+          fi
+
+      - name: Check out the base revision
+        if: steps.changed-tests.outputs.found == 'true'
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout-4
+        with:
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: base
+          persist-credentials: false
+
+      - name: Set up Python
+        if: steps.changed-tests.outputs.found == 'true'
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 #sync-pin:setup-python-2
+        with:
+          python-version-file: "base/.python-version"
+
+      - name: Setup uv
+        if: steps.changed-tests.outputs.found == 'true'
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv-2
+        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
+
+      - name: Run the changed tests against the base code
+        if: steps.changed-tests.outputs.found == 'true'
+        working-directory: base
+        run: |
+          git apply "$RUNNER_TEMP/tests.patch"
+          uv sync --locked
+          set +e
+          xargs -0 uv run --no-sync pytest -- < "$RUNNER_TEMP/changed-tests"
+          status=$?
+          set -e
+          if [ "$status" -eq 0 ]; then
+            echo "::warning::The changed tests already pass on the base revision. Check whether the fix is still needed."
+            echo "### Regression proof: base already passes :warning:" >> "$GITHUB_STEP_SUMMARY"
+            echo "The changed tests pass without the pull request's code changes." >> "$GITHUB_STEP_SUMMARY"
+          else
+            echo "The changed tests fail on the base revision as expected (pytest exit code $status)."
+            echo "### Regression proof: base fails as expected :white_check_mark:" >> "$GITHUB_STEP_SUMMARY"
+          fi
+
   coverage-combine:
     needs:
       - test
     runs-on: ubuntu-latest
     timeout-minutes: 5
-    permissions:
-      contents: read
     steps:
       - name: Dump GitHub context
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
 
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout-5
         with:
           persist-credentials: false
 
       - name: Setup uv
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 #sync-pin:setup-uv-3
         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
@@ -149,7 +224,7 @@ jobs:
         run: uv sync --locked
 
       - name: Get coverage files
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 #sync-pin:download-artifact
         with:
           pattern: coverage-*
           path: coverage
@@ -161,14 +236,14 @@ jobs:
       - run: uv run coverage xml
 
       - name: Store coverage HTML
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 #sync-pin:upload-artifact-2
         with:
           name: coverage-html
           path: htmlcov
           include-hidden-files: true
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0 #sync-pin:codecov-action
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
@@ -182,6 +257,7 @@ jobs:
     needs:
       - test
       - coverage-combine
+      - regression-test
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
@@ -190,7 +266,7 @@ jobs:
           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
+        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2 #sync-pin:alls-green
         with:
           jobs: ${{ toJSON(needs) }}
           allowed-skips: test,coverage-combine

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.github/workflows/zizmor.yml

@@ -18,8 +18,8 @@ jobs:
       security-events: write # Required for upload-sarif (used by zizmor-action) to upload SARIF files.
     steps:
       - name: Checkout repository
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 #sync-pin:checkout
         with:
           persist-credentials: false
       - name: Run zizmor
-        uses: zizmorcore/zizmor-action@6599ee8b7a49aef6a770f63d261d214911a7ce02 # v0.6.0
+        uses: zizmorcore/zizmor-action@3dc1ecc9bcb9e94e9b2c709687979e1298497054 # v0.6.2 #sync-pin:zizmor-action

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.gitignore

@@ -31,5 +31,6 @@ Thumbs.db
 *.tmp
 
 # Local environment
-.env
 .run/
+/CLAUDE.md
+/.claude/

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/.pre-commit-config.yaml

@@ -38,14 +38,14 @@ repos:
 
       - id: local-mypy
         name: mypy check
-        entry: uv run mypy fastapi_router_versioning
+        entry: uv run mypy fastapi_router_versioning examples
         require_serial: true
         language: unsupported
         pass_filenames: false
 
       - id: local-ty
         name: ty check
-        entry: uv run ty check fastapi_router_versioning
+        entry: uv run ty check fastapi_router_versioning examples
         require_serial: true
         language: unsupported
         pass_filenames: false

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: fastapi-router-versioning
-Version: 1.0.0
+Version: 1.0.2
 Summary: Router-based API versioning for FastAPI, with per-version docs and a declarative route lifecycle.
 Project-URL: Homepage, https://github.com/mat81black/fastapi-router-versioning
 Project-URL: Repository, https://github.com/mat81black/fastapi-router-versioning
 Project-URL: Issues, https://github.com/mat81black/fastapi-router-versioning/issues
 Project-URL: Documentation, https://github.com/mat81black/fastapi-router-versioning#readme
-Project-URL: Changelog, https://github.com/mat81black/fastapi-router-versioning/blob/main/RELEASE_NOTES.md
+Project-URL: Changelog, https://github.com/mat81black/fastapi-router-versioning/blob/main/release-notes.md
 Author-email: Matteo Nieddu <mat81black@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
@@ -150,6 +150,9 @@ def legacy_route():
 | v2.0    | yes               | **yes**            |
 | v3.0    | no                | n/a                |
 
+`remove_in` is optional: `deprecate_in` alone marks a route deprecated from that version
+onward with no planned removal, staying available (and deprecated) in every later version.
+
 A route without `@api_version` isn't excluded, it falls back to `default_version`
 (`(1, 0)` for SemVer, `"1"` for CalVer, unless overridden).
 
@@ -162,6 +165,11 @@ shows as deprecated in every version, including ones before `deprecate_in`'s bou
 Use one or the other: `deprecated=True` for an unconditional, version-independent flag,
 `deprecate_in` for a per-version lifecycle.
 
+A route with `methods=["GET", "POST"]` can have just one of its methods taken over by a
+dedicated route in a later version; the other method keeps being served by the original
+route. See [`semver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_app.py)
+for a working example.
+
 ---
 
 ## `RouterVersioner` reference
@@ -252,6 +260,10 @@ GET /versions
 }
 ```
 
+If several `RouterVersioner` instances share one app and all set `include_versions_route=True`,
+`/versions` is mounted once and lists every instance's versions together, instead of the
+first instance shadowing the rest (see [Multiple routers](#multiple-routers)).
+
 ### Custom URL format
 
 `prefix_format` and `semantic_version_format` control how a version renders in URLs and in
@@ -422,7 +434,9 @@ pass them all to one `RouterVersioner` via `routers=[...]` instead (see
 If you do share an app across instances, one rule is enforced for you: every instance needs
 its own `prefix_format`/`latest_prefix`. Two instances that resolve to the same prefix would
 otherwise overwrite each other's docs/openapi routes at the same path; this raises
-`RuntimeError`.
+`RuntimeError`. `/versions` (see [Version discovery endpoint](#version-discovery-endpoint))
+doesn't need this coordination: every instance's contribution is aggregated into the same
+endpoint automatically.
 
 For modules that genuinely don't need to coordinate at all, mount them as separate FastAPI
 sub-applications instead (next section).
@@ -460,13 +474,18 @@ RouterVersioner(
 ).versionize()
 ```
 
+If `versionize()` raises (e.g. the callback itself throws), don't catch the exception and
+retry: some versions may already be mounted, and this package makes no attempt to undo that.
+`versionize()` normally runs at startup, so the app simply fails to start — fix the underlying
+issue and start it again.
+
 ---
 
 ## Examples
 
 | File | What it shows |
 |---|---|
-| [`semver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_app.py) | Full SemVer lifecycle: introduce, deprecate, remove |
+| [`semver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_app.py) | Full SemVer lifecycle: introduce, deprecate, remove, permanent deprecation, multi-method route with partial takeover |
 | [`calver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/calver_app.py) | Same lifecycle, CalVer date strings instead |
 | [`semver_major_only_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_major_only_app.py) | Major-only URLs (`/v1`, `/v2`) via `prefix_format` |
 | [`webhook_versioning_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/webhook_versioning_app.py) | Per-version webhook definitions via `webhook_routers` |
@@ -480,7 +499,7 @@ RouterVersioner(
 
 ## Release Notes
 
-[RELEASE_NOTES](https://github.com/mat81black/fastapi-router-versioning/blob/main/RELEASE_NOTES.md)
+[RELEASE_NOTES](https://github.com/mat81black/fastapi-router-versioning/blob/main/release-notes.md)
 
 ---
 

{fastapi_router_versioning-1.0.0 → fastapi_router_versioning-1.0.2}/README.md

@@ -119,6 +119,9 @@ def legacy_route():
 | v2.0    | yes               | **yes**            |
 | v3.0    | no                | n/a                |
 
+`remove_in` is optional: `deprecate_in` alone marks a route deprecated from that version
+onward with no planned removal, staying available (and deprecated) in every later version.
+
 A route without `@api_version` isn't excluded, it falls back to `default_version`
 (`(1, 0)` for SemVer, `"1"` for CalVer, unless overridden).
 
@@ -131,6 +134,11 @@ shows as deprecated in every version, including ones before `deprecate_in`'s bou
 Use one or the other: `deprecated=True` for an unconditional, version-independent flag,
 `deprecate_in` for a per-version lifecycle.
 
+A route with `methods=["GET", "POST"]` can have just one of its methods taken over by a
+dedicated route in a later version; the other method keeps being served by the original
+route. See [`semver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_app.py)
+for a working example.
+
 ---
 
 ## `RouterVersioner` reference
@@ -221,6 +229,10 @@ GET /versions
 }
 ```
 
+If several `RouterVersioner` instances share one app and all set `include_versions_route=True`,
+`/versions` is mounted once and lists every instance's versions together, instead of the
+first instance shadowing the rest (see [Multiple routers](#multiple-routers)).
+
 ### Custom URL format
 
 `prefix_format` and `semantic_version_format` control how a version renders in URLs and in
@@ -391,7 +403,9 @@ pass them all to one `RouterVersioner` via `routers=[...]` instead (see
 If you do share an app across instances, one rule is enforced for you: every instance needs
 its own `prefix_format`/`latest_prefix`. Two instances that resolve to the same prefix would
 otherwise overwrite each other's docs/openapi routes at the same path; this raises
-`RuntimeError`.
+`RuntimeError`. `/versions` (see [Version discovery endpoint](#version-discovery-endpoint))
+doesn't need this coordination: every instance's contribution is aggregated into the same
+endpoint automatically.
 
 For modules that genuinely don't need to coordinate at all, mount them as separate FastAPI
 sub-applications instead (next section).
@@ -429,13 +443,18 @@ RouterVersioner(
 ).versionize()
 ```
 
+If `versionize()` raises (e.g. the callback itself throws), don't catch the exception and
+retry: some versions may already be mounted, and this package makes no attempt to undo that.
+`versionize()` normally runs at startup, so the app simply fails to start — fix the underlying
+issue and start it again.
+
 ---
 
 ## Examples
 
 | File | What it shows |
 |---|---|
-| [`semver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_app.py) | Full SemVer lifecycle: introduce, deprecate, remove |
+| [`semver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_app.py) | Full SemVer lifecycle: introduce, deprecate, remove, permanent deprecation, multi-method route with partial takeover |
 | [`calver_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/calver_app.py) | Same lifecycle, CalVer date strings instead |
 | [`semver_major_only_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/semver_major_only_app.py) | Major-only URLs (`/v1`, `/v2`) via `prefix_format` |
 | [`webhook_versioning_app.py`](https://github.com/mat81black/fastapi-router-versioning/blob/main/examples/webhook_versioning_app.py) | Per-version webhook definitions via `webhook_routers` |
@@ -449,7 +468,7 @@ RouterVersioner(
 
 ## Release Notes
 
-[RELEASE_NOTES](https://github.com/mat81black/fastapi-router-versioning/blob/main/RELEASE_NOTES.md)
+[RELEASE_NOTES](https://github.com/mat81black/fastapi-router-versioning/blob/main/release-notes.md)
 
 ---