From f9623889bbe05021ffee15bea349bb9bf4b245dd Mon Sep 17 00:00:00 2001 From: "Jurriaan H. Spaaks" Date: Tue, 13 Apr 2021 07:09:49 +0200 Subject: [PATCH 1/6] updated name of github action --- .github/workflows/test.yml | 2 +- README.md | 21 +++++++++++++++++---- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4fd4da27..4f129866 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Test +name: tests on: release: diff --git a/README.md b/README.md index a2553870..7131bbcb 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,26 @@ # Netherlands eScience Center Python Template -[![RSD](https://img.shields.io/badge/rsd-python--template-00a3e3.svg)](https://research-software.nl/software/nlesc-python-template) -[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/a99ph5fv1carejrr/branch/main?svg=true)](https://ci.appveyor.com/project/jvdzwaan/python-template/branch/main) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1310751.svg)](https://doi.org/10.5281/zenodo.1310751) - Spend less time setting up and configuring your new Python packages and comply with the [Netherlands eScience Center Software Development Guide](https://guide.esciencecenter.nl/) from the start. +## Badges + +| fair-software.nl recommendations | | +| :-- | :-- | +| (1/5) code repository | [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](https://github.com/nlesc/python-template) | +| (2/5) license | [![github license badge](https://img.shields.io/github/license/nlesc/python-template)](https://github.com/nlesc/python-template) | +| (3/5) community registry | [![RSD](https://img.shields.io/badge/rsd-python--template-00a3e3.svg)](https://research-software.nl/software/nlesc-python-template) | +| (4/5) citation | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1310751.svg)](https://doi.org/10.5281/zenodo.1310751) | +| (5/5) checklist |   | +| overall | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) | +| **Other best practices** |   | +| Appveyor | [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/a99ph5fv1carejrr/branch/main?svg=true)](https://ci.appveyor.com/project/jvdzwaan/python-template/branch/main) +| **GitHub Actions** |   | +| MarkDown link checker | [![workflow mlc badge](https://github.com/nlesc/python-template/workflows/markdown-link-checker/badge.svg)](https://github.com/nlesc/python-template/actions?query=workflow%3A%22markdown-link-checker%22) | +| Citation metadata consistency | [![workflow cffconvert badge](https://github.com/nlesc/python-template/workflows/cffconvert/badge.svg)](https://github.com/nlesc/python-template/actions?query=workflow%3A%22cffconvert%22) | +| Unit tests | [![workflow tests badge](https://github.com/nlesc/python-template/workflows/tests/badge.svg)](https://github.com/nlesc/python-template/actions?query=workflow%3Atests) | + Use this [Cookiecutter](https://cookiecutter.readthedocs.io) template to generate an empty Python package. Features include: From a66f4dfa5ed57409966f7ddc8cc3fa074c35d7d3 Mon Sep 17 00:00:00 2001 From: "Jurriaan H. Spaaks" Date: Tue, 13 Apr 2021 07:10:20 +0200 Subject: [PATCH 2/6] updated name of github action --- .github/workflows/{test.yml => tests.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{test.yml => tests.yml} (100%) diff --git a/.github/workflows/test.yml b/.github/workflows/tests.yml similarity index 100% rename from .github/workflows/test.yml rename to .github/workflows/tests.yml From 4c6b697c9acd6afd987dbb1e3e03090d91777c4b Mon Sep 17 00:00:00 2001 From: "Jurriaan H. Spaaks" Date: Tue, 13 Apr 2021 07:15:39 +0200 Subject: [PATCH 3/6] added github action to monitor consistency of CITATION.cff with .zenodo.json --- .github/workflows/cffconvert.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/cffconvert.yml diff --git a/.github/workflows/cffconvert.yml b/.github/workflows/cffconvert.yml new file mode 100644 index 00000000..7eb3b274 --- /dev/null +++ b/.github/workflows/cffconvert.yml @@ -0,0 +1,14 @@ +name: cffconvert + +on: push + +jobs: + verify: + name: "cffconvert" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + name: Check out a copy of the repository + + - uses: citation-file-format/cffconvert-github-action@main + name: Check whether the citation metadata from CITATION.cff is equivalent to that in .zenodo.json From f5574b0dc1b0929bece466523faaa1d7db2f0e5b Mon Sep 17 00:00:00 2001 From: "Jurriaan H. Spaaks" Date: Tue, 13 Apr 2021 07:18:15 +0200 Subject: [PATCH 4/6] updated trigger type for workflow tests --- .github/workflows/tests.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 4f129866..3b06278f 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,8 +1,6 @@ name: tests -on: - release: - types: [created] +on: push jobs: deploy: From 3758cfc4f158d970da75a2aed20fd6f7e8b95dce Mon Sep 17 00:00:00 2001 From: "Jurriaan H. Spaaks" Date: Tue, 13 Apr 2021 07:21:01 +0200 Subject: [PATCH 5/6] Update tests.yml - renamed job since it doesnt deploy anymore - workflow now also installs wheel - pip install no longer uses `-r requirements.txt` --- .github/workflows/tests.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 3b06278f..b525c2bb 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -3,7 +3,7 @@ name: tests on: push jobs: - deploy: + tests: runs-on: ubuntu-latest @@ -15,8 +15,8 @@ jobs: python-version: '3.x' - name: Install dependencies run: | - python -m pip install --upgrade pip - pip install -r requirements.txt + python -m pip install --upgrade pip wheel + pip install .[dev] - name: Run tests run: | pytest From 1f8683c27450981e31af86a56bc6193bd194027d Mon Sep 17 00:00:00 2001 From: "Jurriaan H. Spaaks" Date: Tue, 13 Apr 2021 07:23:52 +0200 Subject: [PATCH 6/6] undo wheel and requirements.txt, keep job rename --- .github/workflows/tests.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index b525c2bb..05941518 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -15,8 +15,8 @@ jobs: python-version: '3.x' - name: Install dependencies run: | - python -m pip install --upgrade pip wheel - pip install .[dev] + python -m pip install --upgrade pip + pip install -r requirements.txt - name: Run tests run: | pytest