fix docs #1141
Workflow file for this run
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: Test pre-commit, code and docs | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| - uses: pre-commit/[email protected] | |
| test_code: | |
| needs: [pre-commit] | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| max-parallel: 12 | |
| matrix: | |
| python-version: ["3.10"] | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: "pip" | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| run: | | |
| pip install . | |
| pip install pytest pytest_regressions | |
| - name: Test with pytest | |
| run: pytest tests/ | |
| test_code_coverage: | |
| runs-on: ubuntu-latest | |
| needs: [pre-commit] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| cache: "pip" | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| run: | | |
| pip install -e . | |
| - name: Test with pytest | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install pytest klayout lytest scikit-image pytest-cov pytest_regressions | |
| pytest --cov=ubcpdk tests/ | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: true | |
| test_docs: | |
| needs: [pre-commit] | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| max-parallel: 12 | |
| matrix: | |
| python-version: [3.9] | |
| os: [ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: conda-incubator/setup-miniconda@v2 | |
| with: | |
| python-version: 3.9 | |
| channels: conda-forge,defaults | |
| channel-priority: true | |
| activate-environment: anaconda-client-env | |
| - name: Add conda to system path | |
| run: | | |
| echo $CONDA/bin >> $GITHUB_PATH | |
| - name: Install dependencies | |
| run: | | |
| sudo apt install pandoc | |
| make plugins | |
| pip install -e .[docs] --upgrade | |
| pip install numpy --upgrade | |
| conda list > requirements.txt | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: requirements | |
| path: requirements.txt | |
| - name: Test documentation | |
| env: | |
| TIDY3D_USER: ${{ secrets.TIDY3D_EMAIL }} | |
| TIDY3D_PASS: ${{ secrets.TIDY3D_PASSWORD }} | |
| DISPLAY: 1.0 | |
| DOCS: True | |
| GDSFACTORY_LAYOUT_PLOTTER: klayout | |
| run: | | |
| mkdir -p $HOME/.tidy3d | |
| make docs |