docs: rewrite README, CONTRIBUTING, and ARCHITECTURE in a consistent,… #58
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: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| test: | |
| name: test (py${{ matrix.python-version }}) | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: "pip" | |
| - name: Install package (dev extras) | |
| run: pip install -e ".[dev]" | |
| - name: Lint (ruff) | |
| run: ruff check src/ tests/ examples/ | |
| - name: Format check (black) | |
| run: black --check src/ tests/ examples/ | |
| - name: Type check (mypy) | |
| run: mypy src/codefix_env/ --ignore-missing-imports | |
| continue-on-error: true # tighten later | |
| - name: Run tests with coverage | |
| run: | | |
| PYTHONPATH=src pytest tests/ -v --timeout=60 \ | |
| --cov=src/codefix_env \ | |
| --cov-report=xml \ | |
| --cov-report=term | |
| - name: Upload coverage | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-py${{ matrix.python-version }} | |
| path: coverage.xml | |
| cli-smoke-test: | |
| name: CLI Smoke Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install package | |
| run: pip install -e . | |
| - name: Confirm server actually boots | |
| run: | | |
| codefix-server serve --port 8123 & | |
| SERVER_PID=$! | |
| sleep 4 | |
| curl -f http://localhost:8123/health || (echo "Server failed to start" && kill $SERVER_PID && exit 1) | |
| kill $SERVER_PID |