Docs and README. Test coverage badge. #5
This file contains hidden or 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: tests | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| workflow_dispatch: | |
| jobs: | |
| tests-with-vcr: | |
| strategy: | |
| matrix: | |
| os: [ "ubuntu-latest", "macos-latest", "windows-latest" ] | |
| python-version: ["3.10", "3.11", "3.12", "3.13"] | |
| defaults: | |
| run: | |
| shell: bash | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| id: setup-python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| installer-parallel: true | |
| - name: Load cached pip wheels | |
| id: cached-pip-wheels | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cache/pip | |
| ~/Library/Caches/pip | |
| ~\AppData\Local\pip\Cache | |
| key: pip-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} | |
| - name: Install dependencies | |
| run: poetry install --no-interaction --with dev --no-root | |
| - name: Code formatting checks | |
| run: | | |
| poetry run black --check contextgem dev tests | |
| poetry run isort --check contextgem dev tests | |
| poetry check --lock | |
| - name: Run coverage (with VCR) | |
| run: | | |
| source $VENV | |
| coverage run --source contextgem -m pytest --maxfail=1 --disable-warnings -v | |
| coverage report -m | |
| coverage xml -o coverage_quick.xml | |
| - name: Extract coverage | |
| id: get_coverage | |
| run: | | |
| COVERAGE=$(python -c "import xml.etree.ElementTree as ET; print(round(float(ET.parse('coverage_quick.xml').getroot().attrib['line-rate'])*100))") | |
| echo "percentage=$COVERAGE" >> $GITHUB_OUTPUT | |
| - name: Update coverage badge | |
| uses: schneegans/dynamic-badges-action@v1.7.0 | |
| with: | |
| auth: ${{ secrets.GIST_SECRET }} | |
| gistID: daaee00e1dfff7a29ca10a922ec3becd | |
| filename: coverage.json | |
| label: coverage | |
| message: ${{ steps.get_coverage.outputs.percentage }}% | |
| color: $([ ${{ steps.get_coverage.outputs.percentage }} -ge 80 ] && echo 'success' || ([ ${{ steps.get_coverage.outputs.percentage }} -ge 60 ] && echo 'yellow' || echo 'critical')) | |
| env: | |
| CONTEXTGEM_OPENAI_API_KEY: ${{ secrets.CONTEXTGEM_OPENAI_API_KEY }} |