Skip to content

Commit

Permalink
[INFRA] Add citation file and validation workflow (#173)
Browse files Browse the repository at this point in the history
* [INFRA] add citation cff and validation workflow (#135)

---------

Co-authored-by: Remi Gau <[email protected]>
Co-authored-by: Alyssa Dai <[email protected]>
Co-authored-by: Jonathan Armoza <[email protected]>
  • Loading branch information
4 people authored Jun 27, 2023
1 parent 86eb634 commit 7e12f09
Show file tree
Hide file tree
Showing 2 changed files with 75 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: ['main']
pull_request:
branches: ['main']

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
52 changes: 52 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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 CLI: Command line tool for Neurobagel data parsing and annotation"

version: 0.1.0

abstract: "The Bagel CLI is a simple Python command line tool to automatically read and annotate a [BIDS dataset](https://bids-specification.readthedocs.io/en/stable/) so that it can be integrated into the Neurobagel graph."

message: "If you use this software, please cite it as below."

repository-code: "https://github.com/neurobagel/bagel-cli.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: [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 7e12f09

Please sign in to comment.