Skip to content

Update README.md

Update README.md #29

Workflow file for this run

name: CI
on:
push:
branches: [ "main", "master" ]
pull_request:
branches: [ "main", "master" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
# --- NEW: Cache dependencies ---
- name: Get pip cache dir
id: pip-cache
run: |
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
- name: Cache dependencies
uses: actions/cache@v3
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
python -m pip install --upgrade pip
# Install black and ruff for linting/formatting
pip install ".[test]" black ruff
# --- NEW: Linter and Formatter Steps ---
- name: Check formatting with Black
run: |
black --check .
- name: Lint with Ruff
run: |
ruff check .
- name: Test with pytest and generate coverage report
run: |
# Add --cov to measure code coverage
pytest --cov=upgrade_tool --cov-report=xml
# --- NEW (Optional but Recommended): Upload coverage report ---
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }} # You need to set this secret in your repo
file: ./coverage.xml