test docs on pull requests #696
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
| # This workflow will upload a Python Package using Twine when a release is created | |
| # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries | |
| name: Upload Python Package | |
| on: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| branches: [master] | |
| release: | |
| types: [created] | |
| jobs: | |
| test-docs: | |
| runs-on: ubuntu-latest | |
| if: github.event_name != 'release' && !github.event.pull_request.draft | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - run: python -m venv .venv | |
| - run: .venv/bin/activate | |
| if: matrix.os == 'ubuntu-latest' | |
| - run: source .venv/bin/activate | |
| if: matrix.os == 'macos-latest' | |
| - run: .venv\Scripts\activate | |
| if: matrix.os == 'windows-latest' | |
| - name: Install dependencies | |
| run: | | |
| cd docs | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Build Docs | |
| run: make html | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| if: github.event_name != 'release' && !github.event.pull_request.draft | |
| env: | |
| REDBRICK_SDK_API_KEY: ${{ secrets.REDBRICK_SDK_API_KEY }} | |
| REDBRICK_SDK_URL: ${{ secrets.REDBRICK_SDK_URL }} | |
| REDBRICK_SDK_ORG_ID: ${{ secrets.REDBRICK_SDK_ORG_ID }} | |
| REDBRICK_SDK_PROJECT_ID: ${{ secrets.REDBRICK_SDK_PROJECT_ID }} | |
| REDBRICK_SDK_SOURCE: GITHUB | |
| REDBRICK_SDK_DEBUG: 1 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: ["ubuntu-latest", "macos-latest", "windows-latest"] | |
| python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - run: python -m venv .venv | |
| - run: .venv/bin/activate | |
| if: matrix.os == 'ubuntu-latest' | |
| - run: source .venv/bin/activate | |
| if: matrix.os == 'macos-latest' | |
| - run: .venv\Scripts\activate | |
| if: matrix.os == 'windows-latest' | |
| - name: Install dependencies | |
| run: make install | |
| - name: Lint + Unit Tests | |
| run: make test | |
| deploy: | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'release' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Build and publish | |
| env: | |
| TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} | |
| TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} | |
| run: | | |
| python -m venv .venv | |
| .venv/bin/activate | |
| make build | |
| twine upload dist/* |