Awesome
github-action-contributors
Github action generates dynamic image URL for contributor list to display it!
The contributors list is fetched from GitHub API.
Contributors
As always, thanks to our amazing contributors!
<a href="https://github.com/jaywcjlove/github-action-contributors/graphs/contributors"> <img src="https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg" /> </a>Write contributors(htmlTable
) to markdown Example:
Bot Users:
<!--GAMFC_TABEL_BOTS--><table><tr> <td align="center"> <a href="https://github.com/github-actions[bot]" title="github-actions[bot]"> <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="100;" alt="github-actions[bot]"/> <br /><sub><b>github-actions[bot]</b></sub> </a> </td> <td align="center"> <a href="https://github.com/renovate[bot]" title="renovate[bot]"> <img src="https://avatars.githubusercontent.com/in/2740?v=4" width="100;" alt="renovate[bot]"/> <br /><sub><b>renovate[bot]</b></sub> </a> </td> </tr></table><!--GAMFC_TABEL_BOTS-END-->Collaborators Users:
<!--GAMFC_TABEL_COLLABORATORS--><table><tr> <td align="center"> <a href="https://github.com/jaywcjlove" title="小弟调调"> <img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="100;" alt="小弟调调"/> <br /><sub><b>小弟调调</b></sub> </a> </td> </tr></table><!--GAMFC_TABEL_COLLABORATORS-END-->Write contributors(htmlList
) to markdown Example:
Usage
- run: mkdir -p build
- name: Generate Contributors Images
uses: jaywcjlove/github-action-contributors@main
with:
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
output: build/CONTRIBUTORS.svg
avatarSize: 42
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build
https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg
Use in markdown
## Contributors
As always, thanks to our amazing contributors!
<a href="https://github.com/jaywcjlove/github-action-contributors/graphs/contributors">
<img src="https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg" />
</a>
Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
<a href="https://github.com/jaywcjlove/github-action-contributors/graphs/contributors">
<img src="https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg" />
</a>
Write contributors(htmlList
) to markdown
- name: Generate Contributors Images
uses: jaywcjlove/github-action-contributors@main
id: contributors
with:
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
avatarSize: 42
- name: Modify README.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
path: README.md
body: '${{steps.contributors.outputs.htmlList}}'
Use in README.md
markdown
## Contributors
As always, thanks to our amazing contributors!
<!--GAMFC--><a href="https://github.com/jaywcjlove" title="小弟调调"><img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="小弟调调"/></a><!--GAMFC-END-->
Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
Write contributors(htmlList
) to markdown Example:
Write contributors(htmlTable
) to markdown
- name: Generate Contributors Images
uses: jaywcjlove/github-action-contributors@main
id: contributors
with:
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
openDelimiter: '<!--GAMFC_DELIMITER-->'
closeDelimiter: '<!--GAMFC_DELIMITER-END-->'
hideName: 'true' # Hide names in htmlTable
avatarSize: 100 # Set the avatar size.
- name: Modify htmlTable README.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
path: README.md
body: '${{steps.contributors.outputs.htmlTable}}'
Use in README.md
markdown
## Contributors
As always, thanks to our amazing contributors!
<!--GAMFC_DELIMITER-->will be replaced here<!--GAMFC_DELIMITER-END-->
Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
Write contributors(htmlTable
) to markdown Example:
Bot Users:
<!--GAMFC_TABEL_HIDE_NAME_BOTS--><table><tr> <td align="center"> <a href="https://github.com/github-actions[bot]"> <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="100;" alt="github-actions[bot]"/> </a> </td> <td align="center"> <a href="https://github.com/renovate[bot]"> <img src="https://avatars.githubusercontent.com/in/2740?v=4" width="100;" alt="renovate[bot]"/> </a> </td> </tr></table><!--GAMFC_TABEL_HIDE_NAME_BOTS-END-->Inputs
token
- YourGITHUB_TOKEN
. This is required. Why do we needtoken
? Read more here: About the GITHUB_TOKEN secret. Default:${{ github.token }}
filter-author
- Regular expression filtering'.count
- Specify the max count of contributors listed. Default list all contributors(max 100).output
- output image path. default:CONTRIBUTORS.svg
truncate
- Truncate username by specified length,0
for no truncate. default:12
svgWidth
- Width of the generated SVG. default:740
avatarSize
- Size of user avatar. default:24
avatarMargin
- Margin of user avatar. default:5
hideName
- Hide names inhtmlTable
userNameHeight
- Height of user name. default:0
svgTemplate
- Template to render SVG.
<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
svg
svg image string:<svg xmlns....
.htmlTable
Contributor HTML <Table> form stringhtmlTableBots
Contributor(Bot Users) HTML <Table> form stringhtmlList
Contributor HTML <a> list form stringhtmlListBots
Contributor(Bot Users) HTML <a> list form stringhtmlCollaboratorsTable
Collaborators user HTML <Table> form stringhtmlCollaboratorsTableBots
Collaborators user(Bot Users) HTML <Table> form stringhtmlCollaboratorsList
Collaborators user HTML <a> list form stringhtmlCollaboratorsListBots
Collaborators user(Bot Users) HTML <a> form string
htmlTable
<table>
<tr>
<td align="center">
<a href="https://github.com/jaywcjlove">
<img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="jaywcjlove"/><br />
<sub><b>jaywcjlove</b></sub>
</a>
</td>
</tr>
</table>
htmlList
<a href="https://github.com/jaywcjlove">
<img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="jaywcjlove"/>
</a>
<a href="https://github.com/github-actions[bot]">
<img src="https://avatars.githubusercontent.com/in/15368?v=4" width="36;" alt="github-actions[bot]"/>
</a
Quick Start
$ npm install
$ npm run watch # Listen compile .ts files.
$ npm run build # compile .ts files.
Related
- Github Release Changelog Generator A GitHub Action that compares the commit differences between two branches
- Create Tags From Auto create tags from commit or package.json.
- Create Coverage Badges Create coverage badges from coverage reports. (no 3rd parties servers)
- Create Coverage Package Read and modify the contents of
package.json
. - Generated Badges Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
Contributors
As always, thanks to our amazing contributors!
<!--GAMFC--><a href="https://github.com/jaywcjlove" title="小弟调调"><img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="小弟调调"/></a><!--GAMFC-END-->Made with contributors.
License
Licensed under the MIT License.