Merge pull request #2 from pavelacamposp/feature/ci-workflow

Add CI workflow using GitHub Actions

Author: pavelacamposp

.github/workflows/code_quality.yml

@@ -0,0 +1,42 @@
+---
+name: Code Quality
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container: python:3.10-slim
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          apt-get update
+          apt-get install -y git build-essential
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Lint with ruff
+        run: ruff check --output-format=github --line-length 79
+
+      - name: Run mypy
+        run: |
+          mypy \
+          --ignore-missing-imports \
+          --disallow-untyped-defs \
+          --strict-optional \
+          --warn-unused-ignores \
+          --disable-error-code type-arg \
+          .
+
+      - name: YAML Lint
+        run: yamllint --strict .

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+---
+name: Tests
+
+on:
+  workflow_run:
+    workflows: ["Code Quality"]
+    types:
+      - completed
+
+jobs:
+  run_tests_if_successful_build:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python:
+          - version: "3.10"
+            image: "python:3.10-slim"
+          - version: "3.11"
+            image: "python:3.11-slim"
+          - version: "3.12"
+            image: "python:3.12-slim"
+    container:
+      image: ${{ matrix.python.image }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          apt-get update
+          apt-get install -y git build-essential
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Run tests with coverage
+        run: |
+          coverage run -m pytest --maxfail=2 --disable-warnings tests/
+          coverage report

.pre-commit-config.yaml

@@ -30,4 +30,7 @@ repos:
     hooks:
       - id: yamllint
         args: ["--strict"]
-        exclude: ^\.github/workflows/
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint

.yamllint.yaml

@@ -0,0 +1,6 @@
+---
+extends: default
+
+ignore: |
+  .*/*
+  venv/*

requirements-dev.txt

@@ -1,7 +1,10 @@
 git+https://github.com/pavelacamposp/direct_data_driven_mpc.git
 genesis_world==0.2.1
-numpy==2.2.4
+numpy>=1.26.4
 torch==2.6.0
 pre-commit
 ruff
 mypy
+yamllint
+pytest
+coverage

requirements.txt

@@ -1,4 +1,4 @@
 git+https://github.com/pavelacamposp/direct_data_driven_mpc.git
 genesis_world==0.2.1
-numpy==2.2.4
+numpy>=1.26.4
 torch==2.6.0

tests/test_placeholder.py

@@ -0,0 +1,2 @@
+def test_placeholder() -> None:
+    assert True