docs: add coverage badge in README.md #6
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: ci-cd | |
| on: [push, pull_request] | |
| jobs: | |
| ci: | |
| # Set up operating system | |
| runs-on: ubuntu-latest | |
| # Define job steps | |
| steps: | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Check-out repository | |
| uses: actions/checkout@v4 | |
| - name: Install poetry | |
| uses: snok/install-poetry@v1 | |
| - name: Install package | |
| run: poetry install | |
| - name: Linter | |
| uses: psf/black@stable | |
| - name: Test with pytest | |
| run: poetry run pytest tests/ --cov=sysloss --cov-report=xml | |
| - name: Use Codecov to track coverage | |
| uses: codecov/[email protected] | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| slug: geddy11/sysloss | |
| #files: ./coverage.xml # coverage report (dont enable) | |
| # - name: Coverage badge | |
| # uses: tj-actions/coverage-badge-py@v2 | |
| - name: Install Jupyter-book | |
| run: pip install jupyter-book==1.0.0 sphinx-autoapi matplotlib toml scipy rich rustworkx pandas numpy | |
| - name: Create Sphinx configuration | |
| run: jupyter-book config sphinx docs | |
| - name: Build documentation | |
| run: sphinx-build docs docs/_build/html -b html | |
| cd: | |
| permissions: | |
| id-token: write | |
| contents: write | |
| # Only run this job if the "ci" job passes | |
| needs: ci | |
| # Only run this job if new work is pushed to "main" | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| # Set up operating system | |
| runs-on: ubuntu-latest | |
| # Define job steps | |
| steps: | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Check-out repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Use Python Semantic Release to prepare release | |
| id: release | |
| uses: python-semantic-release/[email protected] | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Publish to TestPyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| if: steps.release.outputs.released == 'true' | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| password: ${{ secrets.TEST_PYPI_API_TOKEN }} | |
| - name: Test install from TestPyPI | |
| if: steps.release.outputs.released == 'true' | |
| run: | | |
| pip install \ | |
| --index-url https://test.pypi.org/simple/ \ | |
| --extra-index-url https://pypi.org/simple \ | |
| sysloss | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| if: steps.release.outputs.released == 'true' | |
| with: | |
| password: ${{ secrets.PYPI_API_TOKEN }} | |
| - name: Publish package distributions to GitHub Releases | |
| uses: python-semantic-release/upload-to-gh-release@main | |
| if: steps.release.outputs.released == 'true' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |