Merge #144

144: Add coverage GHA r=charleskawczynski a=charleskawczynski

This PR adds coverage GHA, and updates the readme.

Co-authored-by: Charles Kawczynski <[email protected]>

Author: bors[bot]

.github/codecov.yml

@@ -0,0 +1,11 @@
+comment: false
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        # this allows a 10% drop from the previous base commit coverage
+        threshold: 10%
+
+github_checks:
+    annotations: false

.github/workflows/CodeCov.yml

@@ -0,0 +1,43 @@
+name: CodeCov
+
+on:
+  push:
+    branches:
+      - main
+      - trying
+      - staging
+    tags: '*'
+  pull_request:
+
+jobs:
+  codecov:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/[email protected]
+
+    - name: Set up Julia
+      uses: julia-actions/setup-julia@latest
+      with:
+        version: 1.8
+
+    - name: Test with coverage
+      env:
+        JULIA_PROJECT: "@."
+      run: |
+        julia --project=@. -e 'using Pkg; Pkg.instantiate()'
+        julia --project=@. -e 'using Pkg; Pkg.test(coverage=true)'
+
+    - name: Generate coverage file
+      env:
+        JULIA_PROJECT: "@."
+      run: julia --project=@. -e 'using Pkg; Pkg.add("Coverage");
+                                  using Coverage;
+                                  LCOV.writefile("coverage-lcov.info", Codecov.process_folder())'
+      if: success()
+
+    - name: Submit coverage
+      uses: codecov/[email protected]
+      with:
+        token: ${{secrets.CODECOV_TOKEN}}
+      if: success()

README.md

@@ -1,5 +1,22 @@
 # ClimaTimeSteppers.jl
 
-[![Docs latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://clima.github.io/ClimaTimeSteppers.jl/dev/)
+|||
+|---------------------:|:----------------------------------------------|
+| **Docs Build**       | [![docs build][docs-bld-img]][docs-bld-url]   |
+| **Documentation**    | [![dev][docs-dev-img]][docs-dev-url]          |
+| **GHA CI**           | [![gha ci][gha-ci-img]][gha-ci-url]           |
+| **Code Coverage**    | [![codecov][codecov-img]][codecov-url]        |
+
+[docs-bld-img]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/docs.yml/badge.svg
+[docs-bld-url]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/docs.yml
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://CliMA.github.io/ClimaTimeSteppers.jl/dev/
+
+[gha-ci-img]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/ci.yml/badge.svg
+[gha-ci-url]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/ci.yml
+
+[codecov-img]: https://codecov.io/gh/CliMA/ClimaTimeSteppers.jl/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/CliMA/ClimaTimeSteppers.jl
 
 A CPU- and GPU-friendly package for solving ordinary differential equations