mention installation of main #43
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: CI | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "v*" | |
| pull_request: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: "0 0 * * 0" # every week (for --pre release tests) | |
| jobs: | |
| check-manifest: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: pipx run check-manifest | |
| test: | |
| name: ${{ matrix.platform }} (${{ matrix.python-version }}) | |
| runs-on: ${{ matrix.platform }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ['3.9', '3.10', '3.11'] | |
| platform: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache-dependency-path: "pyproject.toml" | |
| cache: "pip" | |
| - name: Set up QT libraries | |
| uses: tlambert03/setup-qt-libs@v1 | |
| # if running a cron job, we add the --pre flag to test against pre-releases | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install -U pip | |
| python -m pip install .[test] ${{ github.event_name == 'schedule' && '--pre' || '' }} | |
| - name: Test | |
| uses: aganders3/headless-gui@v1 | |
| with: | |
| run: pytest --color=yes --cov --cov-report=xml --cov-report=term-missing | |
| # If something goes wrong, we can open an issue in the repo | |
| - name: Report --pre Failures | |
| if: failure() && github.event_name == 'schedule' | |
| uses: JasonEtco/create-an-issue@v2 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PLATFORM: ${{ matrix.platform }} | |
| PYTHON: ${{ matrix.python-version }} | |
| RUN_ID: ${{ github.run_id }} | |
| TITLE: '[test-bot] pip install --pre is failing' | |
| with: | |
| filename: .github/TEST_FAIL_TEMPLATE.md | |
| update_existing: true | |
| - name: Coverage | |
| uses: codecov/codecov-action@v3 | |
| docs: | |
| name: Generate Docs | |
| needs: test | |
| if: success() && github.event_name != 'schedule' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| working-directory: ./docs | |
| run: | | |
| pip install -U pip | |
| pip install -r requirements.txt | |
| - name: Build the book | |
| working-directory: ./docs | |
| run: | | |
| jupyter-book build . | |
| - name: GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html | |
| deploy: | |
| name: Deploy | |
| needs: test | |
| if: success() && startsWith(github.ref, 'refs/tags/') && github.event_name != 'schedule' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: install | |
| run: | | |
| pip install -U pip build twine | |
| python -m build | |
| twine check dist/* | |
| - name: Build and publish | |
| run: twine upload dist/* | |
| env: | |
| TWINE_USERNAME: __token__ | |
| TWINE_PASSWORD: ${{ secrets.TWINE_API_KEY }} | |
| - uses: softprops/action-gh-release@v1 | |
| with: | |
| generate_release_notes: true |