Update the doc string #345
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
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: Python package | |
| on: [push, pull_request] | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: "3.9" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install ".[pre-commit]" | |
| - name: Run pre-commit | |
| run: "pre-commit run --all" | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [3.7, 3.8, 3.9] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install ".[test]" | |
| - name: Test with pytest | |
| run: | | |
| pytest tests/ | |
| - name: Run coverage from coverage-python by running pytest yet again | |
| if: ${{ matrix.python-version == '3.9' }} | |
| run: pytest --cov-report=xml --cov-append --cov=easyunfold | |
| - name: Upload coverage to Codecov | |
| if: ${{ matrix.python-version == '3.9' }} | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| name: easyunfold | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| publish-pypi: | |
| needs: [build] | |
| if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') && (github.repository == 'SMTG-Bham/easyunfold') | |
| name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python 3.9 | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: 3.9 | |
| - name: Build | |
| run: | | |
| python3 -m pip install --upgrade build | |
| python3 -m build | |
| - name: Publish distribution 📦 to PyPI | |
| uses: pypa/gh-action-pypi-publish@master | |
| with: | |
| user: __token__ | |
| password: ${{ secrets.PYPI_API_TOKEN }} |