[ENH] add suite test for docstring and get_test_params coverage
#2102
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 | |
| on: | |
| push: | |
| paths-ignore: | |
| - 'docs/**' | |
| branches: | |
| - main | |
| - 'release**' | |
| pull_request: | |
| branches: | |
| - main | |
| - 'release**' | |
| paths-ignore: | |
| - 'docs/**' | |
| types: [opened, synchronize] | |
| # Allows workflows to be manually triggered | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| # Needed for the 'trilom/file-changes-action' action | |
| pull-requests: read | |
| concurrency: | |
| group: ${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| code-quality: | |
| name: code-quality | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: repository checkout step | |
| uses: actions/checkout@v4 | |
| - name: python environment step | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: install pre-commit | |
| run: python3 -m pip install pre-commit | |
| - id: changed-files | |
| name: identify modified files | |
| uses: tj-actions/changed-files@v45 | |
| - name: run pre-commit hooks on modified files | |
| run: pre-commit run --color always --files ${{ steps.changed-files.outputs.all_changed_files }} --show-diff-on-failure | |
| - name: check missing __init__ files | |
| run: build_tools/fail_on_missing_init_files.sh | |
| shell: bash | |
| run-notebook-examples: | |
| needs: code-quality | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.9 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install .[all_extras,binder,dev] | |
| - name: Run example notebooks | |
| run: build_tools/run_examples.sh | |
| shell: bash | |
| run-tests-no-extras: | |
| needs: code-quality | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| os: [ubuntu-latest, windows-latest, macOS-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: git remote set-branches origin 'main' | |
| - run: git fetch --depth 1 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Display Python version | |
| run: python -c "import sys; print(sys.version)" | |
| - name: Install skpro and dependencies | |
| run: | | |
| python -m pip install .[dev] --no-cache-dir | |
| - name: Show dependencies | |
| run: python -m pip list | |
| - name: Show available branches | |
| run: git branch -a | |
| - name: Run tests | |
| run: make test | |
| - name: Publish code coverage | |
| uses: codecov/codecov-action@v4 | |
| run-tests-all-extras: | |
| needs: code-quality | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| os: [ubuntu-latest, windows-latest, macOS-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: git remote set-branches origin 'main' | |
| - run: git fetch --depth 1 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Display Python version | |
| run: python -c "import sys; print(sys.version)" | |
| - name: Install skpro and dependencies | |
| run: | | |
| python -m pip install .[all_extras,dev] --no-cache-dir | |
| - name: Show dependencies | |
| run: python -m pip list | |
| - name: Show available branches | |
| run: git branch -a | |
| - name: Run tests | |
| run: make test | |
| - name: Publish code coverage | |
| uses: codecov/codecov-action@v4 |