Skip to content

Commit

Permalink
chore: add docs update references CI
Browse files Browse the repository at this point in the history
  • Loading branch information
Lancetnik committed May 29, 2024
1 parent f88ce8e commit 6a7b82b
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 21 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/docs_update-references.yaml
Original file line number Diff line number Diff line change
@@ -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
20 changes: 0 additions & 20 deletions .github/workflows/pr_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 6a7b82b

Please sign in to comment.