From c0798fd2b92069006844d8e80c1c5b6b3bbd082b Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 15:42:18 +0200 Subject: [PATCH 1/9] Add codecov to CI --- .github/workflows/ci.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 602ddd7..4b0bd47 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -99,7 +99,12 @@ jobs: - name: Tests run: | - pytest --cov + pytest --cov --cov-report=xml + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v4 + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} docs: runs-on: ubuntu-latest From b90e72188ef7f472026dc9cfd203078934ea7d7c Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 15:44:58 +0200 Subject: [PATCH 2/9] Add changelog --- docs/changes/7.maintenance.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/changes/7.maintenance.rst diff --git a/docs/changes/7.maintenance.rst b/docs/changes/7.maintenance.rst new file mode 100644 index 0000000..ca143b2 --- /dev/null +++ b/docs/changes/7.maintenance.rst @@ -0,0 +1 @@ +- Add Codecov report to CI From 72b4d7625fd0695256422182e1292c4590f5ee67 Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 15:57:41 +0200 Subject: [PATCH 3/9] Add CI badge to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fb69705..f12e224 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# radiotools +=============== +radiotools |ci| +=============== + +.. |ci| image:: https://github.com/radionets-project/radiotools/workflows/CI/badge.svg?branch=main + :target: https://github.com/radionets-project/radiotools/actions?query=workflow%3ACI+branch%3Amain + :alt: Test Status + + Collection of tools for use in radio astronomy. ## Installation From d9072c4a8d84e7f157427d81b58f4b985f6adbb7 Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 15:58:38 +0200 Subject: [PATCH 4/9] Change README.md to README.rst --- README.md => README.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.md => README.rst (100%) diff --git a/README.md b/README.rst similarity index 100% rename from README.md rename to README.rst From e3a9e355ad773038c1120569777234ee9d063937 Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 16:03:59 +0200 Subject: [PATCH 5/9] Add CI status badge --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f12e224..e3b338a 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ radiotools |ci| =============== -.. |ci| image:: https://github.com/radionets-project/radiotools/workflows/CI/badge.svg?branch=main - :target: https://github.com/radionets-project/radiotools/actions?query=workflow%3ACI+branch%3Amain +.. |ci| image:: https://github.com/radionets-project/radiotools/actions/workflows/ci.yml/badge.svg?branch=main + :target: https://github.com/radionets-project/radiotools/actions/workflows/ci.yml?branch=main :alt: Test Status From c8815cc3bb259853e10e7cc079d79bc780bbcfaf Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 16:23:48 +0200 Subject: [PATCH 6/9] Update README --- README.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index e3b338a..456de5d 100644 --- a/README.rst +++ b/README.rst @@ -9,10 +9,17 @@ radiotools |ci| Collection of tools for use in radio astronomy. -## Installation -You can install the necessary packages in a conda/mamba environment of your choice by executing -``` -$ pip install -e . -``` -If you want to use features from the NRAO [CASAtools](https://pypi.org/project/casatools/) package, -you must use a python 3.10 version. + +Installation +============ + +*radiotools* can be installed via pip by calling + +.. code:: + + $ pip install -e . + +We recommend using a conda/mamba environment with python version ``<=3.11``. + +If you want to use features from the NRAO `*CASAtools* `_ package, +you make sure you are using python 3.10 or 3.11. From b288ae2e3b8d9890c6beaa03fd053519e696de6f Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Thu, 10 Oct 2024 16:27:31 +0200 Subject: [PATCH 7/9] Fix casatools hyperlink in README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 456de5d..5b84005 100644 --- a/README.rst +++ b/README.rst @@ -21,5 +21,5 @@ Installation We recommend using a conda/mamba environment with python version ``<=3.11``. -If you want to use features from the NRAO `*CASAtools* `_ package, +If you want to use features from the NRAO `CASAtools `_ package, you make sure you are using python 3.10 or 3.11. From efb750a927b75cd34e06a7d11b06862c5850c494 Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Fri, 11 Oct 2024 11:14:01 +0200 Subject: [PATCH 8/9] Add codecov badge --- README.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 456de5d..6df9adb 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,15 @@ -=============== -radiotools |ci| -=============== +========================= +radiotools |ci| |codecov| +========================= .. |ci| image:: https://github.com/radionets-project/radiotools/actions/workflows/ci.yml/badge.svg?branch=main :target: https://github.com/radionets-project/radiotools/actions/workflows/ci.yml?branch=main :alt: Test Status +.. |codecov| image:: https://codecov.io/github/radionets-project/radiotools/badge.svg + :target: https://codecov.io/github/radionets-project/radiotools + :alt: Code coverage + Collection of tools for use in radio astronomy. From 2438c7591ad21888dfd655da4eff97f3155f2413 Mon Sep 17 00:00:00 2001 From: Anno Knierim Date: Fri, 11 Oct 2024 14:59:38 +0200 Subject: [PATCH 9/9] Update codecov action --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4b0bd47..b4315a9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -103,8 +103,8 @@ jobs: - name: Upload coverage to Codecov uses: codecov/codecov-action@v4 - env: - CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + with: + token: ${{ secrets.CODECOV_TOKEN }} docs: runs-on: ubuntu-latest