diff --git a/.github/workflows/docs_update-references.yaml b/.github/workflows/docs_update-references.yaml new file mode 100644 index 0000000000..a462164752 --- /dev/null +++ b/.github/workflows/docs_update-references.yaml @@ -0,0 +1,30 @@ +name: Generate API References documentation + +on: + pull_request: + types: + - opened + - synchronize + paths: + - faststream/** + +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: Check for changes + id: git-diff + run: git diff --exit-code \ No newline at end of file diff --git a/.github/workflows/pr_tests.yaml b/.github/workflows/pr_tests.yaml index d482e1c0f7..204dd3c30d 100644 --- a/.github/workflows/pr_tests.yaml +++ b/.github/workflows/pr_tests.yaml @@ -38,26 +38,6 @@ jobs: shell: bash run: semgrep scan --config auto --error - # 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: Check for changes - # id: git-diff - # run: git diff --exit-code - test-basic: if: github.event.pull_request.draft == false runs-on: ubuntu-latest diff --git a/pyproject.toml b/pyproject.toml index 5b22e5c4c8..686cb7c2df 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -79,7 +79,7 @@ otel = ["opentelemetry-sdk>=1.24.0,<2.0.0"] optionals = ["faststream[rabbit,kafka,confluent,nats,redis,otel]"] devdocs = [ - "mkdocs-material==9.5.25", + "mkdocs-material==9.5.24", "mkdocs-static-i18n==1.2.3", "mdx-include==1.4.2", "mkdocstrings[python]==0.25.1",