Editing cff and adding of validation to reactivate auto-detection of releases by zenodo (#159)

* First scratch for CFF file validateion.

* use uv

* update the cff validation.yml file.

* Fix uv versions.

* Use uv.

* fiy uv action version.

* Bring the funding section.

* fix cffconvert check for zenodo.

* Fix License-2.0

* Use --with option in uv run.

* minor edits on the cff, otherwise #159 is ready for a merge

---------

Co-authored-by: mkuehbach <markus.kuehbach@physik.hu-berlin.de>

Author: RubelMozumder

.github/workflows/cff-validation.yml

@@ -0,0 +1,37 @@
+name: Validate CITATION.cff
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "CITATION.cff"
+      - ".github/workflows/cff-validation.yml"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "CITATION.cff"
+      - ".github/workflows/cff-validation.yml"
+
+env:
+  PYTHON_VERSION: 3.12
+
+jobs:
+  validate-cff:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Test Zenodo conversion
+        run: |
+          # Remove the funding section to avoid validation issues with Zenodo
+          sed -i '/^funding:/,$d' CITATION.cff 
+
+          uv run --with cffconvert cffconvert --validate --format zenodo || exit 1

CITATION.cff

@@ -5,6 +5,7 @@ message:
   If you use this software, please cite it using the
   metadata from this file.
 type: software
+
 authors:
   - given-names: Markus
     family-names: Kühbach
@@ -27,9 +28,9 @@ authors:
   - given-names: Claudia
     family-names: Draxl
     orcid: 'https://orcid.org/0000-0003-3523-6657'
-doi: 10.5281/zenodo.14263105
-repository-code: https://github.com/FAIRmat-NFDI/pynxtools-em
-url: https://zenodo.org/records/14263105
+repository-code: 'https://github.com/FAIRmat-NFDI/pynxtools-em'
+doi: '10.5281/zenodo.14263105'
+url: 'https://zenodo.org/records/14263105'
 keywords:
   - NeXus
   - pynxtools
@@ -39,17 +40,17 @@ keywords:
   - Microscopy
 abstract:
   pynxtools-em is a reader plugin for pynxtools (https://github.com/FAIRmat-NFDI/pynxtools)
-  written in Python. pynxtools-em is a tool for reading and translating data from various proprietary
-  and open-source data formats from technology partners and the wider electron microscopy community and
-  standardizing it such that it is compliant with the NeXus application definition NXem
-  (https://fairmat-nfdi.github.io/nexus_definitions/).
+  written in Python. It is a tool for reading and translating data from various proprietary
+  and open-source data formats of technology partners from electron microscopy community.
+  The tool standardizes metadata and data such that these are compliant with the NeXus
+  application definition NXem (https://fairmat-nfdi.github.io/nexus_definitions/).
 
   pynxtools-em is developed both as a standalone reader and as a tool within NOMAD,
   an open-source research data management platform for Materials Science (https://nomad-lab.eu/nomad-lab/).
 
   The work is funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - 460197019 (FAIRmat)
   (https://gepris.dfg.de/gepris/projekt/460197019?language=en).
-license: Apache Software License 2.0
+license: Apache-2.0
 funding:
   - name: Deutsche Forschungsgemeinschaft
     award-number: 460197019