actions-marketplace-validations/Contributors List

Automatically generate contributors.svg for your repository

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
GITHUB_TOKEN	Your GitHub token for authentication.	yes	—
repo	The repository name in form of "userName/repoName".	no	—
sort	Specify if sort contributors by contributions or not. Default `true`.	no	true
count	Specify the max count of contributors listed. Default list all contributors.	no	—
round	Specify if clip the avatar to rounded or not. Default `true`.	no	true
truncate	Truncate username by specified length, `0` for no truncate.	no	12
affiliation	Type of collaborators options: all/direct/outside.	no	direct
includeBots	Should include bots or not.	no	false
excludeUsers	Users to exclude.	no	—
svgPath	Path to save the generated SVG.	no	CONTRIBUTORS.svg
svgWidth	Width of the generated SVG.	no	740
avatarSize	Size of user avatar.	no	64
avatarMargin	Margin of user avatar.	no	5
userNameHeight	Height of user name.	no	0
svgTemplate	Template to render SVG.	no	<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="{{ width }}" height="{{ contributorsHeight }}" > <style>.contributor-link { cursor: pointer; }</style> {{{ contributors }}} </svg>
itemTemplate	Template to render user item.	no	<a xlink:href="{{{ url }}}" class="contributor-link" target="_blank" rel="nofollow sponsored" title="{{{ name }}}" id="{{{ name }}}"> <image x="{{ x }}" y="{{ y }}" width="{{ width }}" height="{{ height }}" xlink:href="{{{ avatar }}}" /> </a>
commitMessage	Commit message of the github action.	no	chore: update contributors [skip ci]
noCommit	Changes will not be committed. This options requires a local clone and will updated if required the contributor svg.	no	false

Outputs

no outputs