DO NOT MERGE!!! Experimenting #865
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate API References documentation | |
| on: | |
| pull_request_target: | |
| types: | |
| - opened | |
| - synchronize | |
| - ready_for_review | |
| 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 | |
| with: | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| ref: ${{ github.head_ref }} | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| version: "latest" | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install Dependencies | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| shell: bash | |
| # should install with `-e` | |
| run: | | |
| set -ux | |
| uv pip install --system -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" |