Skip to content

Commit

Permalink
[MAINT] add citation.cff file and validation workflow (#55)
Browse files Browse the repository at this point in the history
* add cff file

* add dependabot
  • Loading branch information
Remi-Gau authored Dec 14, 2023
1 parent 916e155 commit ac447d2
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
# Documentation
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
18 changes: 18 additions & 0 deletions .github/workflows/validate_cff.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: validate CITATION.cff

on:
push:
branches: main
pull_request:
branches: ['*']

jobs:
validate_cff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check whether the citation metadata from CITATION.cff is valid
uses: citation-file-format/[email protected]
with:
args: --validate
29 changes: 29 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
cff-version: 1.2.0

title: "giga_connectome"

version: 0.4.1dev

abstract:
"generate connectome from fMRIPrep outputs."

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

repository-code: "https://github.com/SIMEXP/giga_connectome"

contact:
- email: [email protected]
family-names: Wang
given-names: Hao-Ting

authors:
- family-names: Wang
given-names: Hao-Ting
email: [email protected]
- family-names: Dessain
given-names: Quentin
- family-names: Natasha
given-names: Clarke


license: MIT

0 comments on commit ac447d2

Please sign in to comment.