DOC: Restore deleted see also description #677
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 | |
| on: | |
| push: | |
| branches: | |
| - '*' | |
| tags-ignore: | |
| - 'v[0-9]*' | |
| pull_request: | |
| workflow_call: | |
| inputs: | |
| skip_codecov: | |
| type: boolean | |
| required: false | |
| default: false | |
| jobs: | |
| unittests: | |
| runs-on: ubuntu-latest | |
| # We want to run on external PRs, but not on our own internal PRs as they'll be run | |
| # by the push to the branch. | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
| strategy: | |
| matrix: | |
| python-version: [3.9, 3.12] | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Packages | |
| shell: bash | |
| run: | | |
| # Install as an editable so that the coverage path | |
| # is predicable | |
| pip install -e ".[extra,test]" | |
| - name: Environment Information | |
| shell: bash | |
| run: | | |
| pip list | |
| - name: Run Tests | |
| shell: bash | |
| run: | | |
| coverage erase | |
| make test | |
| - name: List Directory | |
| shell: bash | |
| run: | | |
| ls -la | |
| - uses: actions/upload-artifact@v3 | |
| if: failure() | |
| with: | |
| name: result-images | |
| path: tests/result_images/ | |
| if-no-files-found: ignore | |
| # To change secrets | |
| # https://app.codecov.io/github/has2k1/plotnine/settings | |
| # https://github.com/has2k1/plotnine/settings/secrets/actions | |
| - name: Upload coverage to Codecov | |
| if: ${{ !inputs.skip_codecov }} | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| name: "py${{ matrix.python-version }}" | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: true | |
| lint-and-format: | |
| runs-on: ubuntu-latest | |
| # We want to run on external PRs, but not on our own internal PRs as they'll be run | |
| # by the push to the branch. | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
| strategy: | |
| matrix: | |
| python-version: [3.11] | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Packages | |
| shell: bash | |
| run: | | |
| pip install ruff | |
| - name: Environment Information | |
| shell: bash | |
| run: pip list | |
| - name: Check lint with Ruff | |
| shell: bash | |
| run: | | |
| make lint | |
| - name: Check format with Ruff | |
| shell: bash | |
| run: | | |
| make format | |
| typecheck: | |
| runs-on: ubuntu-latest | |
| # We want to run on external PRs, but not on our own internal PRs as they'll be run | |
| # by the push to the branch. | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
| strategy: | |
| matrix: | |
| python-version: [3.11] | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Packages | |
| shell: bash | |
| run: | | |
| pip install ".[extra, typing]" | |
| - name: Environment Information | |
| shell: bash | |
| run: pip list | |
| - name: Run Tests | |
| shell: bash | |
| run: make typecheck | |
| call-build-documentation: | |
| if: | | |
| github.event_name == 'push' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| uses: ./.github/workflows/documentation.yml |