Docs: execute notebooks during deployment #22
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: Build python wheels | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| tags: | ||
| - '*' | ||
| pull_request: | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | ||
| cancel-in-progress: true | ||
| jobs: | ||
| build_wheels: | ||
| name: Build wheels on ${{ matrix.os }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| matrix: | ||
| os: [ubuntu-20.04, windows-2019, macos-11] | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Build wheels | ||
| uses: pypa/cibuildwheel@v2.15.0 | ||
| - uses: actions/upload-artifact@v3 | ||
| with: | ||
| path: ./wheelhouse/*.whl | ||
| build_sdist: | ||
| name: Build source distribution | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Build sdist | ||
| run: pipx run build --sdist | ||
| - uses: actions/upload-artifact@v3 | ||
| with: | ||
| path: dist/*.tar.gz | ||
| build_docs: | ||
| if: github.ref == 'refs/heads/main' | ||
| name: Build documentation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Install dependencies | ||
| run: pip install .[docs] opencv-python-headless | ||
| - name: Restore cached juypter notebook results | ||
| id: cache-docs-jupyter | ||
| uses: actions/cache/restore@v3 | ||
| with: | ||
| path: ./.jupyter_cache | ||
| key: docs-jupyter | ||
| - name: Build documentation | ||
| run: python -m sphinx -b html docs public | ||
| - uses: actions/upload-pages-artifact@v2 | ||
| with: | ||
| path: ./public | ||
| deploy: | ||
| if: github.ref == 'refs/heads/main' | ||
| name: Deploy documentation | ||
| permissions: | ||
| pages: write | ||
| id-token: write | ||
| needs: build_docs | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v2 | ||
| upload_pypi: | ||
| name: Upload to PyPI | ||
| needs: [build_wheels, build_sdist] | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: pypi | ||
| url: https://pypi.org/p/opticalmapping | ||
| permissions: | ||
| id-token: write | ||
| if: github.event_name == 'release' && github.event.action == 'published' | ||
| steps: | ||
| - uses: actions/download-artifact@v3 | ||
| with: | ||
| name: artifact | ||
| path: dist | ||
| - name: Publish package distributions to PyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
