Add documentation for how to use with Numpy and Pandas #402
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
| name: test-and-release | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - release/* # this is a backup. prefer publishing using a tagged master. | |
| tags: | |
| - 'v[0-9]+.[0-9]+.[0-9]+' | |
| pull_request: | |
| branches: | |
| - master | |
| workflow_dispatch: | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| max-parallel: 5 | |
| matrix: | |
| # https://github.com/actions/python-versions/blob/main/versions-manifest.json | |
| python-version: [3.7, 3.8, 3.9, "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| allow-prereleases: true | |
| - name: Install Poetry and dependencies | |
| run: | | |
| set -e | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| poetry install --all-extras | |
| - name: Lint with flake8 | |
| run: | | |
| set -e | |
| poetry run flake8 dataclasses_json --show-source --statistics --count | |
| - name: Test with pytest | |
| run: | | |
| set -euxo pipefail | |
| poetry run pytest ./tests --doctest-modules --junitxml=junit/test-results.xml --cov=. --cov-report=term-missing:skip-covered | tee pytest-coverage.txt | |
| - name: Publish Code Coverage | |
| uses: MishaKav/pytest-coverage-comment@main | |
| if: ${{ !github.event.pull_request.head.repo.fork }} | |
| with: | |
| pytest-coverage-path: ./pytest-coverage.txt | |
| junitxml-path: ./junit/test-results.xml | |
| release: | |
| needs: [test] | |
| if: startsWith(github.ref, 'refs/tags') | |
| environment: release | |
| runs-on: ubuntu-latest | |
| permissions: | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9.x" | |
| - name: Install Poetry and Prepare version | |
| run: | | |
| set -e | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| poetry self add "poetry-dynamic-versioning[plugin]" | |
| - name: Build package | |
| run: | | |
| set -e | |
| poetry build | |
| - name: Publish distribution 📦 to Test PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| - name: Publish distribution 📦 to PyPI | |
| if: startsWith(github.ref, 'refs/tags') | |
| uses: pypa/gh-action-pypi-publish@release/v1 |