willynilly/CFF Author Updater

Add GitHub and raw commit authors to the authors section of CITATION.cff and post a pull request comment with updated CFF and qualifying contributions from new authors.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github_tokenGitHub token for API accessyes
base_branchThe base branch to compare against (target of PR)yes
head_branchThe head branch (source of PR)yes
cff_pathPath to the CFF file (default is CITATION.cff)noCITATION.cff
post_pr_commentWhether to post a pull request comment (true/false)notrue
show_error_messages_in_pr_commentWhether to show error messages in pull request comment (true/false)notrue
show_warning_messages_in_pr_commentWhether to show warning messages in pull request comment (true/false)notrue
show_info_messages_in_pr_commentWhether to show info messages in pull request comment (true/false)notrue
authorship_for_pr_commitsInclude PR commit authors and co-authors as authorsnotrue
authorship_for_pr_reviewsInclude PR reviewers as authorsnotrue
authorship_for_pr_issuesInclude creators of issues linked to the PR as authorsnotrue
authorship_for_pr_issue_commentsInclude commenters on linked issues as authorsnotrue
authorship_for_pr_commentsInclude users who comment directly on the PR as authorsnotrue
missing_author_invalidates_prInvalidate pull request if a new author is missing from the CFF filetrue
duplicate_author_invalidates_prInvalidate the pull request if there is a duplicate author in the CFF filetrue
invalid_cff_invalidates_prInvalidate the pull request if cffconvert fails to validate the CFF filetrue
can_skip_authorshipWhether manually skipping and unskipping authorship is enabled or nottrue
bot_blacklistComma-separated list of bot usernames to ignorenogithub-actions[bot]
namedescription
new_authorsNew authors and qualifying contributions in JSON
original_cffFull original CFF content in YAML
original_cff_is_valid_cffWhether the original CFF file has valid CFF according to cffconvert ('true' or 'false')
updated_cffFull updated CFF content in YAML. If no changes, this will be the same as the original CFF file.
updated_cff_is_valid_cffWhether the updated CFF file has valid CFF according to cffconvert ('true' or 'false')
updated_cff_has_errorWhether the updated CFF file has an error ('true' or 'false'). An error invalidates the pull request.
updated_cff_has_warningWhether the updated CFF file has an error ('true' or 'false'). A warning does not invalidate the pull request.
error_logLog that contains errors about the CFF author update process.
warning_logLog that contains warnings about the CFF author update process.
info_logLog that contains general information about the CFF author update process.
debug_logLog that contains debug information about the CFF author update process.