Skip to content

Issue I3: CI Smoke Test — GitHub Actions #7

@Ramdam17

Description

@Ramdam17

Description:

Set up a GitHub Actions workflow that runs a minimal smoke test on every push/PR.

Context:
Automated testing ensures that basic functionality doesn't break. A smoke test is a quick sanity check, not comprehensive testing.

Tasks:

  • Create .github/workflows/smoke_test.yml
  • Test matrix: Python 3.9, 3.10, 3.11
  • Smoke test should:
    • Install HyPyP and dependencies
    • import hypyp successfully
    • Run a minimal pipeline (e.g., compute one metric on tiny data)
  • Target runtime: < 5 minutes

Acceptance Criteria:

  • Workflow runs on push to main and on PRs
  • Tests pass on Python 3.9, 3.10, 3.11
  • Total CI time < 5 minutes
  • Clear error messages on failure

Starter template:

name: Smoke Test

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11']
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          pip install poetry
          poetry install
      - name: Run smoke test
        run: |
          python -c "import hypyp; print('Import OK')"
          python tests/smoke_test.py

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions