Skip to content

Commit

Permalink
add citation cff and validation workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Jun 27, 2023
1 parent c6d0742 commit 52f1b69
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/cff_validation.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
with:
args: --validate
46 changes: 46 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
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

- affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
family-names: Dai
given-names: Alyssa

- affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
family-names: Armoza
given-names: Jonathan

- affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
family-names: Jahanpour
given-names: Arman

- affiliation: "ORIGAMI lab, McGill University, Montréal, Canada"
email: [email protected]
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

0 comments on commit 52f1b69

Please sign in to comment.