From 86bea641e8bd19febe5244bb6b99af3c880c2eaa Mon Sep 17 00:00:00 2001
From: Remi Gau <remi_gau@hotmail.com>
Date: Tue, 27 Jun 2023 20:16:29 +0200
Subject: [PATCH] [INFRA] add citation cff and validation workflow (#135)

* add citation cff and validation workflow

* add link to doc and schema

* add Alyssa's ORCID

* Seb in CITATION.cff

* Jonathan Armoza ORCID

---------

Co-authored-by: Alyssa Dai <alyssa.ydai@gmail.com>
Co-authored-by: Sebastian Urchs <surchs@users.noreply.github.com>
Co-authored-by: Jonathan Armoza <jarmoza@gmail.com>
---
 .github/workflows/cff_validation.yml | 23 ++++++++++++
 CITATION.cff                         | 52 ++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 .github/workflows/cff_validation.yml
 create mode 100644 CITATION.cff

diff --git a/.github/workflows/cff_validation.yml b/.github/workflows/cff_validation.yml
new file mode 100644
index 0000000..cb1434a
--- /dev/null
+++ b/.github/workflows/cff_validation.yml
@@ -0,0 +1,23 @@
+---
+name: validate citation.cff
+
+on:
+  push:
+    branches: ['*']
+  pull_request:
+    branches: ['*']
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  validate_cff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Check whether the citation metadata from CITATION.cff is valid
+      uses: citation-file-format/cffconvert-github-action@2.0.0
+      with:
+        args: --validate
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000..c9df043
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,52 @@
+# doc: https://citation-file-format.github.io/
+# schema: https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
+
+cff-version: 1.2.0
+
+title: "neurobagel_api"
+
+version: 0.2.0
+
+abstract: "The Neurobagel API is a REST API, developed in [Python](https://www.python.org/) using [FastAPI](https://fastapi.tiangolo.com/) and [pydantic](https://docs.pydantic.dev/)."
+
+message: "If you use this software, please cite it as below."
+
+repository-code: "https://github.com/neurobagel/api.git"
+
+contact:
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    family-names: Urchs
+    given-names: Sebastian 
+
+authors:
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    family-names: Urchs
+    given-names: Sebastian 
+    orcid: "https://orcid.org/0000-0001-5504-8579"
+
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    family-names: Dai
+    given-names: Alyssa
+    orcid: "https://orcid.org/0000-0003-0174-6800"
+
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    family-names: Armoza
+    given-names: Jonathan
+    orcid: "https://orcid.org/0000-0002-7193-9344"
+
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    family-names: Jahanpour
+    given-names: Arman    
+
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    email:  nikhil.bhagwat@mcgill.ca
+    family-names: Bhagwat
+    given-names: Nikhil
+    orcid: "https://orcid.org/0000-0001-6073-7141"
+
+  - affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
+    family-names: Poline
+    given-names: Jean-Baptiste
+    orcid: "https://orcid.org/0000-0002-9794-749X"    
+
+license: MIT