Merge branch 'master' into advanced-index

.github/DISCUSSION_TEMPLATE/questions.yml

@@ -123,6 +123,20 @@ body:
         ```
     validations:
       required: true
+  - type: input
+    id: pydantic-version
+    attributes:
+      label: Pydantic Version
+      description: |
+        What Pydantic version are you using?
+
+        You can find the Pydantic version with:
+
+        ```bash
+        python -c "import pydantic; print(pydantic.version.VERSION)"
+        ```
+    validations:
+      required: true
   - type: input
     id: python-version
     attributes:

.github/actions/comment-docs-preview-in-pr/Dockerfile

@@ -1,6 +1,8 @@
-FROM python:3.7
+FROM python:3.10
 
-RUN pip install httpx "pydantic==1.5.1" pygithub
+COPY ./requirements.txt /app/requirements.txt
+
+RUN pip install -r /app/requirements.txt
 
 COPY ./app /app
 

.github/actions/comment-docs-preview-in-pr/app/main.py

@@ -6,7 +6,8 @@
 import httpx
 from github import Github
 from github.PullRequest import PullRequest
-from pydantic import BaseModel, BaseSettings, SecretStr, ValidationError
+from pydantic import BaseModel, SecretStr, ValidationError
+from pydantic_settings import BaseSettings
 
 github_api = "https://api.github.com"
 

.github/actions/comment-docs-preview-in-pr/requirements.txt

@@ -0,0 +1,4 @@
+PyGithub
+pydantic>=2.5.3,<3.0.0
+pydantic-settings>=2.1.0,<3.0.0
+httpx

.github/actions/notify-translations/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7
+FROM python:3.9
 
 RUN pip install httpx PyGithub "pydantic==1.5.1" "pyyaml>=5.3.1,<6.0.0"
 

.github/actions/notify-translations/app/main.py

@@ -9,7 +9,7 @@
 from github import Github
 from pydantic import BaseModel, BaseSettings, SecretStr
 
-awaiting_label = "awaiting review"
+awaiting_label = "awaiting-review"
 lang_all_label = "lang-all"
 approved_label = "approved-2"
 translations_path = Path(__file__).parent / "translations.yml"

.github/actions/people/Dockerfile

@@ -1,6 +1,6 @@
-FROM python:3.7
+FROM python:3.9
 
-RUN pip install httpx PyGithub "pydantic==1.5.1" "pyyaml>=5.3.1,<6.0.0"
+RUN pip install httpx PyGithub "pydantic==2.0.2" pydantic-settings "pyyaml>=5.3.1,<6.0.0"
 
 COPY ./app /app
 

.github/actions/people/action.yml

@@ -3,10 +3,7 @@ description: "Generate the data for the FastAPI People page"
 author: "Sebastián Ramírez <tiangolo@gmail.com>"
 inputs:
   token:
-    description: 'User token, to read the GitHub API. Can be passed in using {{ secrets.ACTION_TOKEN }}'
-    required: true
-  standard_token:
-    description: 'Default GitHub Action token, used for the PR. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
+    description: 'User token, to read the GitHub API. Can be passed in using {{ secrets.FASTAPI_PEOPLE }}'
     required: true
 runs:
   using: 'docker'

.github/actions/people/app/main.py

@@ -9,7 +9,8 @@
 import httpx
 import yaml
 from github import Github
-from pydantic import BaseModel, BaseSettings, SecretStr
+from pydantic import BaseModel, SecretStr
+from pydantic_settings import BaseSettings
 
 github_graphql_url = "https://api.github.com/graphql"
 questions_category_id = "MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyMDAxNDM0"
@@ -352,7 +353,6 @@ class SponsorsResponse(BaseModel):
 
 class Settings(BaseSettings):
     input_token: SecretStr
-    input_standard_token: SecretStr
     github_repository: str
     httpx_timeout: int = 30
 
@@ -383,14 +383,15 @@ def get_graphql_response(
     data = response.json()
     if "errors" in data:
         logging.error(f"Errors in response, after: {after}, category_id: {category_id}")
+        logging.error(data["errors"])
         logging.error(response.text)
         raise RuntimeError(response.text)
     return data
 
 
 def get_graphql_issue_edges(*, settings: Settings, after: Union[str, None] = None):
     data = get_graphql_response(settings=settings, query=issues_query, after=after)
-    graphql_response = IssuesResponse.parse_obj(data)
+    graphql_response = IssuesResponse.model_validate(data)
     return graphql_response.data.repository.issues.edges
 
 
@@ -405,19 +406,19 @@ def get_graphql_question_discussion_edges(
         after=after,
         category_id=questions_category_id,
     )
-    graphql_response = DiscussionsResponse.parse_obj(data)
+    graphql_response = DiscussionsResponse.model_validate(data)
     return graphql_response.data.repository.discussions.edges
 
 
 def get_graphql_pr_edges(*, settings: Settings, after: Union[str, None] = None):
     data = get_graphql_response(settings=settings, query=prs_query, after=after)
-    graphql_response = PRsResponse.parse_obj(data)
+    graphql_response = PRsResponse.model_validate(data)
     return graphql_response.data.repository.pullRequests.edges
 
 
 def get_graphql_sponsor_edges(*, settings: Settings, after: Union[str, None] = None):
     data = get_graphql_response(settings=settings, query=sponsors_query, after=after)
-    graphql_response = SponsorsResponse.parse_obj(data)
+    graphql_response = SponsorsResponse.model_validate(data)
     return graphql_response.data.user.sponsorshipsAsMaintainer.edges
 
 
@@ -608,8 +609,8 @@ def get_top_users(
 if __name__ == "__main__":
     logging.basicConfig(level=logging.INFO)
     settings = Settings()
-    logging.info(f"Using config: {settings.json()}")
-    g = Github(settings.input_standard_token.get_secret_value())
+    logging.info(f"Using config: {settings.model_dump_json()}")
+    g = Github(settings.input_token.get_secret_value())
     repo = g.get_repo(settings.github_repository)
     question_commentors, question_last_month_commentors, question_authors = get_experts(
         settings=settings

.github/dependabot.yml

@@ -11,6 +11,10 @@ updates:
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "monthly"
+    groups:
+      python-packages:
+        patterns:
+          - "*"
     commit-message:
       prefix: ⬆

.github/workflows/build-docs.yml

@@ -17,7 +17,7 @@ jobs:
     outputs:
       docs: ${{ steps.filter.outputs.docs }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     # For pull requests it's not necessary to checkout the code but for master it is
     - uses: dorny/paths-filter@v2
       id: filter
@@ -28,30 +28,37 @@ jobs:
             - docs/**
             - docs_src/**
             - requirements-docs.txt
+            - .github/workflows/build-docs.yml
+            - .github/workflows/deploy-docs.yml
   langs:
     needs:
       - changes
     runs-on: ubuntu-latest
     outputs:
       langs: ${{ steps.show-langs.outputs.langs }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
       - uses: actions/cache@v3
         id: cache
         with:
           path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v05
+          key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-tests.txt') }}-v06
       - name: Install docs extras
         if: steps.cache.outputs.cache-hit != 'true'
         run: pip install -r requirements-docs.txt
       # Install MkDocs Material Insiders here just to put it in the cache for the rest of the steps
       - name: Install Material for MkDocs Insiders
-        if: ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false ) && steps.cache.outputs.cache-hit != 'true'
-        run: pip install git+https://${{ secrets.ACTIONS_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
+        if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
+        run: |
+          pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
+          pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
+          pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
+      - name: Verify Docs
+        run: python ./scripts/docs.py verify-docs
       - name: Export Language Codes
         id: show-langs
         run: |
@@ -71,22 +78,25 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
       - uses: actions/cache@v3
         id: cache
         with:
           path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v05
+          key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-tests.txt') }}-v06
       - name: Install docs extras
         if: steps.cache.outputs.cache-hit != 'true'
         run: pip install -r requirements-docs.txt
       - name: Install Material for MkDocs Insiders
-        if: ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false ) && steps.cache.outputs.cache-hit != 'true'
-        run: pip install git+https://${{ secrets.ACTIONS_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
+        if: ( github.event_name != 'pull_request' || github.secret_source != 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
+        run: |
+          pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
+          pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
+          pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
       - name: Update Languages
         run: python ./scripts/docs.py update-languages
       - uses: actions/cache@v3

.github/workflows/deploy-docs.yml

@@ -14,36 +14,35 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Clean site
         run: |
           rm -rf ./site
           mkdir ./site
       - name: Download Artifact Docs
         id: download
-        uses: dawidd6/action-download-artifact@v2.27.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           if_no_artifact_found: ignore
           github_token: ${{ secrets.FASTAPI_PREVIEW_DOCS_DOWNLOAD_ARTIFACTS }}
           workflow: build-docs.yml
           run_id: ${{ github.event.workflow_run.id }}
           name: docs-site
           path: ./site/
-      - name: Deploy to Netlify
+      - name: Deploy to Cloudflare Pages
         if: steps.download.outputs.found_artifact == 'true'
-        id: netlify
-        uses: nwtgck/actions-netlify@v2.0.0
+        id: deploy
+        uses: cloudflare/pages-action@v1
         with:
-          publish-dir: './site'
-          production-deploy: ${{ github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.head_branch == 'master' }}
-          github-token: ${{ secrets.FASTAPI_PREVIEW_DOCS_NETLIFY }}
-          enable-commit-comment: false
-        env:
-          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
-          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: fastapitiangolo
+          directory: './site'
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ ( github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.head_branch == 'master' && 'main' ) || ( github.event.workflow_run.head_sha ) }}
       - name: Comment Deploy
-        if: steps.netlify.outputs.deploy-url != ''
+        if: steps.deploy.outputs.url != ''
         uses: ./.github/actions/comment-docs-preview-in-pr
         with:
           token: ${{ secrets.FASTAPI_PREVIEW_DOCS_COMMENT_DEPLOY }}
-          deploy_url: "${{ steps.netlify.outputs.deploy-url }}"
+          deploy_url: "${{ steps.deploy.outputs.url }}"

.github/workflows/issue-manager.yml

@@ -19,13 +19,21 @@ jobs:
     if: github.repository_owner == 'tiangolo'
     runs-on: ubuntu-latest
     steps:
-      - uses: tiangolo/issue-manager@0.4.0
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: tiangolo/issue-manager@0.5.0
         with:
           token: ${{ secrets.FASTAPI_ISSUE_MANAGER }}
           config: >
             {
               "answered": {
                 "delay": 864000,
                 "message": "Assuming the original need was handled, this will be automatically closed now. But feel free to add more comments or create new issues or PRs."
+              },
+              "changes-requested": {
+                "delay": 2628000,
+                "message": "As this PR had requested changes to be applied but has been inactive for a while, it's now going to be closed. But if there's anyone interested, feel free to create a new PR."
               }
             }

.github/workflows/label-approved.yml

@@ -3,12 +3,25 @@ name: Label Approved
 on:
   schedule:
     - cron: "0 12 * * *"
+  workflow_dispatch:
 
 jobs:
   label-approved:
     if: github.repository_owner == 'tiangolo'
     runs-on: ubuntu-latest
     steps:
-    - uses: docker://tiangolo/label-approved:0.0.2
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - uses: docker://tiangolo/label-approved:0.0.4
       with:
         token: ${{ secrets.FASTAPI_LABEL_APPROVED }}
+        config: >
+          {
+            "approved-1":
+              {
+                "number": 1,
+                "await_label": "awaiting-review"
+              }
+          }

.github/workflows/latest-changes.yml

@@ -14,25 +14,32 @@ on:
       debug_enabled:
         description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
         required: false
-        default: false
+        default: 'false'
 
 jobs:
   latest-changes:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v4
         with:
-          # To allow latest-changes to commit to master
-          token: ${{ secrets.ACTIONS_TOKEN }}
+          # To allow latest-changes to commit to the main branch
+          token: ${{ secrets.FASTAPI_LATEST_CHANGES }}
       # Allow debugging with tmate
       - name: Setup tmate session
         uses: mxschmitt/action-tmate@v3
-        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled }}
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
         with:
           limit-access-to-actor: true
-      - uses: docker://tiangolo/latest-changes:0.0.3
+      - uses: docker://tiangolo/latest-changes:0.3.0
+      # - uses: tiangolo/latest-changes@main
         with:
-          token: ${{ secrets.FASTAPI_LATEST_CHANGES }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           latest_changes_file: docs/en/docs/release-notes.md
-          latest_changes_header: '## Latest Changes\n\n'
+          latest_changes_header: '## Latest Changes'
+          end_regex: '^## '
           debug_logs: true
+          label_header_prefix: '### '