Skip to content
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

Add CITATION.cff based on JOSS paper.md #758

Merged
merged 4 commits into from
May 15, 2024
Merged

Conversation

yarikoptic
Copy link
Member

@yarikoptic yarikoptic commented May 15, 2024

The actual script is pushed to

https://github.com/nipy/heudiconv/blob/paper-joss/tools/paper-to-citationcff

which was ran and then record was tuned up.

edit: purpose - to satisfy JOSS requirement to have release with a matching list of authors. See openjournals/joss-reviews#5839 (comment) and there on

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "../heudiconv-joss-paper/tools/paper-to-citationcff ../heudiconv-joss-paper/paper.md",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@yarikoptic yarikoptic added release Create a release when this pr is merged internal Changes only affect the internal API labels May 15, 2024
@yarikoptic
Copy link
Member Author

FWIW -- CI validated fine:


Run cffconvert --validate
Citation metadata are valid according to schema version [1](https://github.com/nipy/heudiconv/actions/runs/9101979981/job/25020506168?pr=758#step:6:1).2.0.

Copy link

codecov bot commented May 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.04%. Comparing base (6ace2f6) to head (75932d7).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #758   +/-   ##
=======================================
  Coverage   82.04%   82.04%           
=======================================
  Files          42       42           
  Lines        4205     4205           
=======================================
  Hits         3450     3450           
  Misses        755      755           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yarikoptic yarikoptic merged commit 9b181b3 into master May 15, 2024
16 checks passed
@yarikoptic yarikoptic deleted the enh-CITATION-CFF branch May 15, 2024 21:14
Copy link

🚀 PR was released in v1.1.2 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Changes only affect the internal API release Create a release when this pr is merged released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant