docs: improve presentation of contributing guidelines #2200
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
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| release: | |
| types: [published] | |
| name: CI Tests | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| # we are using the -e flag, so that code cov finds the source. | |
| # this is not ideal, since installing an editable can technically | |
| # differ from a normal install in surprising ways. | |
| pip install -e '.[all]' | |
| - name: pytest unit tests | |
| run: | | |
| make test | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| name: "py${{ matrix.python-version }}" | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| test-windows: | |
| runs-on: windows-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dependencies | |
| run: | | |
| pip install -e '.[all]' | |
| - name: pytest unit tests | |
| run: | | |
| make test | |
| test-pandas: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dependencies | |
| run: | | |
| pip install -e '.[dev-no-pandas]' | |
| - name: pytest unit tests | |
| run: | | |
| make test-no-pandas | |
| browser-save-image-test: | |
| name: "Test for saving table image with browser" | |
| runs-on: ubuntu-latest | |
| steps: | |
| # browsers | |
| - uses: browser-actions/setup-firefox@v1 | |
| - run: firefox --version | |
| - uses: browser-actions/setup-chrome@v1 | |
| - run: chrome --version | |
| - uses: browser-actions/setup-edge@v1 | |
| # | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dependencies | |
| run: | | |
| pip install -e '.[extra]' | |
| pip install pandas | |
| - name: save browser tables | |
| run: | | |
| make save-browser-table-ci | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: browser-save-image | |
| path: _browser-tests.html | |
| if-no-files-found: error | |
| release-pypi: | |
| name: "Release to pypi" | |
| runs-on: ubuntu-latest | |
| needs: [build, test-pandas] | |
| if: github.event_name == 'release' | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: "3.10" | |
| - name: "Build Package" | |
| run: | | |
| python -m pip install build wheel | |
| python -m build --sdist --wheel | |
| - name: "Deploy to PyPI" | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| user: __token__ | |
| password: ${{ secrets.PYPI_API_TOKEN }} |