Merge branch 'main' into 975-use-aio-pika-pool

.codespell-whitelist.txt

@@ -1 +1,2 @@
 dependant
+unsecure

.github/PULL_REQUEST_TEMPLATE.md

@@ -22,5 +22,5 @@ Please delete options that are not relevant.
 - [ ] My changes do not generate any new warnings
 - [ ] I have added tests to validate the effectiveness of my fix or the functionality of my new feature
 - [ ] Both new and existing unit tests pass successfully on my local environment by running `scripts/test-cov.sh`
-- [ ] I have ensured that static analysis tests are passing by running `scripts/static-anaylysis.sh`
+- [ ] I have ensured that static analysis tests are passing by running `scripts/static-analysis.sh`
 - [ ] I have included code examples to illustrate the modifications

.github/workflows/check-broken-links-in-docs.yaml → .github/workflows/docs_check-broken-links.yaml

@@ -2,8 +2,10 @@ name: Check docs for broken links
 
 on:
   workflow_run:
-    workflows: ["pages-build-deployment"]
-    types: [completed]
+    types:
+      - completed
+    workflows:
+      - Deploy Docs to GitHub Pages
 
 jobs:
   check-broken-link:

.github/workflows/deploy-docs.yaml → .github/workflows/docs_deploy.yaml

@@ -1,4 +1,5 @@
-name: Deploy Docs
+name: Deploy Docs to GitHub Pages
+
 on:
   push:
     branches:
@@ -10,6 +11,7 @@ on:
 
 permissions:
   contents: write
+
 jobs:
   deploy_docs:
     runs-on: ubuntu-latest

.github/workflows/docs_update-references.yaml

@@ -0,0 +1,38 @@
+name: Generate API References documentation
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths:
+      - faststream/**
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+jobs:
+  check-docs-changes:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+          cache-dependency-path: pyproject.toml
+      - name: Install Dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: pip install -e ".[dev]"
+      - name: Run build docs
+        run: bash scripts/build-docs.sh
+      - name: Commit
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "docs: generate API References"

.github/workflows/update_release_notes.yaml → .github/workflows/docs_update-release-notes.yaml

@@ -1,10 +1,10 @@
-name: Update Release Notes
+name: Create PR with updated Release Notes
 
 on:
   workflow_dispatch: null
-  push:
-    tags:
-      - '*'
+  release:
+    types:
+      - published
 
 jobs:
   update-release-notes:

.github/workflows/codeql.yml → .github/workflows/pr_codeql.yml

@@ -12,14 +12,21 @@
 name: "CodeQL"
 
 on:
-  push:
-    branches: [ "main"]
   pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    types:
+      - opened
+      - synchronize
+    branches:
+      - main
+    paths:
+      - faststream/**
   schedule:
     - cron: '39 20 * * 0'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   analyze:
     if: github.event.pull_request.draft == false

.github/workflows/dependency-review.yaml → .github/workflows/pr_dependency-review.yaml

@@ -5,7 +5,20 @@
 # Source repository: https://github.com/actions/dependency-review-action
 # Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
 name: 'Dependency Review'
-on: [pull_request]
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    branches:
+      - main
+    paths:
+      - pyproject.toml
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 permissions:
   contents: read