Home

Awesome

github-action-contributors

Buy me a coffee Build & Deploy Repo Dependents

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:

<!--GAMFC_TABEL--><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-END-->

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:

<!--GAMFC--><a href="https://github.com/jaywcjlove" title="小弟调调"><img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="小弟调调"/></a><!--GAMFC-END-->

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:

<!--GAMFC--><a href="https://github.com/jaywcjlove" title="小弟调调"><img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="小弟调调"/></a><!--GAMFC-END-->

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:

<!--GAMFC_TABEL_HIDE_NAME--><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="小弟调调"/> </a> </td> </tr></table><!--GAMFC_TABEL_HIDE_NAME-END-->

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

<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

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

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.