-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[INFRA] add citation cff and validation workflow #135
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 |
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_api" | ||
|
||
version: 0.2.0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the issue was talking about version 0.2.0 so I went with this. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @alyssadai if you want to release as 0.1.0, please adjust this line accordingly |
||
|
||
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: [email protected] | ||
family-names: Bhagwat | ||
given-names: Nikhil | ||
orcid: "https://orcid.org/0000-0001-6073-7141" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jarmoza @jarmoza @alyssadai @surchs |
||
|
||
- 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can probably just run this against
main
since we know what our branches are called.