idimetrix/Github Contributors Icon Generator
Github action generates dynamic image URL for contributor list to display it!.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | Your GITHUB_TOKEN | no | ${{ github.token }} |
| filter-author | Regular expression filtering | no | "" |
| count | Specify the max count of contributors listed. Default list all contributors. | no | — |
| output | output image path | no | CONTRIBUTORS.svg |
| truncate | Truncate username by specified length, `0` for no truncate. | no | 12 |
| hideName | Hide names in `htmlTable` | no | — |
| excludeBots | Exclude bots users | no | true |
| svgWidth | Width of the generated SVG. | no | 740 |
| avatarSize | Size of user avatar. | no | 24 |
| 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> |
Outputs
| name | description |
|---|---|
| svg | svg image string |
| htmlTable | Contributor HTML <Table> form string |
| htmlTableBots | Contributor(Bot Users) HTML <Table> form string |
| htmlList | Contributor HTML <a> list form string |
| htmlListBots | Contributor(Bot Users) HTML <a> form string |
| htmlCollaboratorsTable | Collaborators user HTML <Table> form string |
| htmlCollaboratorsTableBots | Collaborators user(Bot Users) HTML <Table> form string |
| htmlCollaboratorsList | Collaborators user HTML <a> list form string |
| htmlCollaboratorsListBots | Collaborators user(Bot Users) HTML <a> form string |