github-action-contributors
Github action generates dynamic image URL for contributor list to display it!
Contributors
Usage
- run: mkdir -p build
- name: Generate Contributors Images
uses: jaywcjlove/github-action-contributors@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
output: build/CONTRIBUTORS.svg
- 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
Inputs
token
Your GITHUB_TOKEN. This is required. Why do we need token? 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.
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
userNameHeight:
Height of user name. default: 0
svgTemplate
Template to render SVG.
{{{ contributors }}} ">
<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
svgsvg image string:
Quick Start
$ npm install
$ npm run watch # Listen compile .ts files.
$ npm run build # compile .ts files.
Contributors
License
Licensed under the MIT License.
3 Mar 25, 2022
4.3k Jan 2, 2023
753 Dec 24, 2022
1.6k Dec 3, 2022
4 Oct 27, 2022
45 Nov 2, 2022
11.2k Dec 30, 2022
5.7k Jan 6, 2023
1.3k Dec 25, 2022
244 Jan 2, 2023
12 Jan 3, 2023
7.9k Dec 27, 2022
29 Dec 30, 2022
71 Dec 11, 2022
46 Oct 15, 2022
75 Dec 22, 2022
9 Oct 1, 2022
3 Dec 15, 2022
2 Mar 22, 2022
20 Dec 11, 2022