Feature/issue 102 add code coverage

.github/workflows/push.yml → .github/workflows/build-pipeline.yml

@@ -20,6 +20,8 @@ env:
 jobs:
   run_tests:
     uses: ./.github/workflows/run_tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
 
   bump_version:
     needs: run_tests

.github/workflows/pull_request.yml

@@ -6,8 +6,13 @@ name: Receive PR
 on:
   pull_request:
     # Sequence of patterns matched against refs/heads
-    branches: [ feature/**, issue/**, issues/** ]
+    branches:
+      - feature/**
+      - issue/**
+      - issues/**
 
 jobs:
   build_and_test:
     uses: ./.github/workflows/run_tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/run_tests.yml

@@ -7,28 +7,32 @@ name: A reusable workflow to build and run the unit test suite
 
 on:
   workflow_call:
+    secrets:
+      codecov_token:
+        required: true
   workflow_dispatch:
 
+env:
+  POETRY_VERSION: "1.3.2"
+  PYTHON_VERSION: "3.10"
+
 jobs:
   build_and_test:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [ '3.10' ]
 
-    name: Python ${{ matrix.python-version }} tests
     steps:
-      - uses: actions/checkout@v4
+      - name: Retrieve repository
+        uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Set up Poetry
         uses: abatilo/actions-poetry@v3.0.0
         with:
-          poetry-version: 1.3.2
+          poetry-version: ${{ env.POETRY_VERSION }}
 
       - name: Install package
         run: poetry install
@@ -41,16 +45,8 @@ jobs:
         run: |
           poetry run pytest --cov=batcher --cov-report=xml:build/reports/coverage.xml --cov-report=html:build/reports/coverage.html tests/
 
-      - name: Archive code coverage report (xml)
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: code coverage report (xml)
-          path: build/reports/coverage.xml
-
-      - name: Archive code coverage report (HTML)
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v4
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
         with:
-          name: code coverage report (HTML)
-          path: build/reports/coverage.html
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

.pre-commit-config.yaml

@@ -15,14 +15,14 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.3.5'
+    rev: 'v0.4.1'
     hooks:
       - id: ruff
         args: [ "--fix" ]
 
   # https://github.com/python/black#version-control-integration
   - repo: https://github.com/psf/black
-    rev: 24.3.0
+    rev: 24.4.0
     hooks:
       - id: black-jupyter
 

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [PR #75](https://github.com/danielfromearth/batchee/pull/75): Add Docker build steps to GitHub Actions workflow
 - [PR #84](https://github.com/danielfromearth/batchee/pull/84): Add readme badges
 - [PR #100](https://github.com/danielfromearth/batchee/pull/100): Add license
+- [PR #111](https://github.com/nasa/batchee/pull/111): Add codecov to CI pipeline
 ### Changed
 - [issue/11](https://github.com/danielfromearth/batchee/issues/11): Rename from concat_batcher to batchee
 - [issue/21](https://github.com/danielfromearth/batchee/issues/21): Improve CICD workflows

pyproject.toml

@@ -49,6 +49,8 @@ exclude = [
   "_typed_ops.pyi",
 ]
 target-version = "py310"
+
+[tool.ruff.lint]
 # E402: module level import not at top of file
 # E501: line too long - let black worry about that
 # E731: do not assign a lambda expression, use a def