hero-bot

Extract heros (contributor) from given repos and add hero avator icon in your markdown

If you encounter dco issue while commit files. Check this branch for solution

Usage

Here is a example yml for reference

Required inputs

key	description	example value
token	Personal access tokens with public_repo access better stored in secret	ghp_xxxx
repos	repos need to collection contributor, /to divide org and repo, , to seperate different repos in same org, ; to seperate different orgs	milvus-io/milvus,milvus.io;facebook/react,ax
target	target path to add collection contributor	milvus-io/milvus/README.md

Optional inputs

key	description	default value	available value
orderKey	contributor is ordered by this key, will always be login if customUserConfig is set	login	login or contributions
isAscend	ascend or descend	True	True or False
userTypeBlackList	filter out user type	Bot	"",Bot,User or Bot,User
width	width of contributor avator icon	40px	proper value for avator icon
showTotal	show total number badge	True	True or False
customUserConfig	custom user list config file path	""	config avatar_url, html_url and login in an array

Customize position

Contributors add to end of file in default.

To customize position, add

anywhere you want. And contributors will be insert inside of if.

Reference

Use @actions/github to fetch contributor from repo and files.
Use @octokit/plugin-create-or-update-text-file to update file.
Use https://shields.io to generate badge.

Sample result from milvus repo