Skip to content

updated docs

updated docs #119

name: CI geeadd
on:
push:
branches: [master]
pull_request:
branches: [master]
workflow_dispatch:
jobs:
# Run tests first
test:
name: Run Tests on ${{ matrix.os }} - Python ${{ matrix.python-version }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ["3.11"]
exclude:
# Optional: reduce matrix size if needed
- os: macos-latest
python-version: "3.9"
- os: windows-latest
python-version: "3.9"
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Display Python version
run: python --version
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest pytest-cov pytest-mock python-box click
- name: Install package in development mode
run: |
pip install -e .
- name: Run tests with pytest
run: |
pytest tests/ -v --tb=short --color=yes
- name: Run tests with coverage (Ubuntu only)
if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
run: |
pytest tests/ --cov=geeadd --cov-report=xml --cov-report=term
- name: Test summary
run: |
echo "Tests passed on ${{ matrix.os }} with Python ${{ matrix.python-version }}"
# Installation verification (keeps your existing checks)
test-installation:
name: Installation Test on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
needs: test # Only run after tests pass
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Display Python version
run: python --version
- name: Install package
run: |
python -m pip install --upgrade pip
pip install .
- name: Verify geeadd installation
run: |
geeadd --version
- name: Test geeadd help
run: |
geeadd --help
- name: Test geeadd -h
run: |
geeadd -h
- name: Installation summary
run: |
echo "Installation successful on ${{ matrix.os }}"
echo "All help commands working correctly"