Add generated CITATION.cff#792
Open
kernelpanic888 wants to merge 1 commit into
Open
Conversation
Member
|
Thanks for contribution. I wait to merge because we first need to discuss proper CITATION.cff in our team. I'd like to roll out for all of our repositories in a consistent way and not having to add a conversion script to every repository. |
Author
|
Thanks, that makes sense. I'll wait for the team decision and am happy to adapt this PR to whatever repository-wide approach you settle on. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related to #784.
This adds a generated
CITATION.cffwhile keepingpackage.jsonas the source of truth.What changed:
bin/citation-cff.jsgenerator with no new dependencies;npm run citation;package.json;CITATION.cffso GitHub can show "Cite this repository" immediately.The generated CFF uses the current
package.jsonname/description, author, contributors, license, version, and repository URL.Local checks:
npm run citation;node --check bin/citation-cff.js;CITATION.cff;CITATION.cffas YAML;git diff --check.I did not run the full project lint because dependencies are not installed in my local checkout. I also could not run
cffconvert --validatebecausecffconvertis not installed in this environment.