{"id":14985996,"url":"https://github.com/jaywcjlove/github-action-contributors","last_synced_at":"2025-04-13T06:42:06.370Z","repository":{"id":40435571,"uuid":"452136412","full_name":"jaywcjlove/github-action-contributors","owner":"jaywcjlove","description":"Github action generates dynamic image URL for contributor list to display it!","archived":false,"fork":false,"pushed_at":"2025-03-17T16:46:02.000Z","size":998,"stargazers_count":36,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-12T23:26:52.899Z","etag":null,"topics":["actions","avatar","avatar-generator","contributors","contributors-avatar","github-actions","svg"],"latest_commit_sha":null,"homepage":"https://jaywcjlove.github.io/github-action-contributors","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaywcjlove.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"jaywcjlove","buy_me_a_coffee":"jaywcjlove","custom":["https://www.paypal.me/kennyiseeyou","https://jaywcjlove.github.io/#/sponsor"]}},"created_at":"2022-01-26T04:09:49.000Z","updated_at":"2025-04-06T05:12:39.000Z","dependencies_parsed_at":"2022-08-09T20:20:57.565Z","dependency_job_id":"f90060f4-612a-4fcd-8954-8cfd80bc5987","html_url":"https://github.com/jaywcjlove/github-action-contributors","commit_stats":{"total_commits":189,"total_committers":4,"mean_commits":47.25,"dds":0.3386243386243386,"last_synced_commit":"7f5eaff09b8185b76bcb81673aad24c0cfdd708c"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fgithub-action-contributors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fgithub-action-contributors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fgithub-action-contributors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fgithub-action-contributors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaywcjlove","download_url":"https://codeload.github.com/jaywcjlove/github-action-contributors/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248675440,"owners_count":21143763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","avatar","avatar-generator","contributors","contributors-avatar","github-actions","svg"],"created_at":"2024-09-24T14:12:06.521Z","updated_at":"2025-04-13T06:42:06.350Z","avatar_url":"https://github.com/jaywcjlove.png","language":"JavaScript","readme":"github-action-contributors\n===\n\n[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)\n[![Build \u0026 Deploy](https://github.com/jaywcjlove/github-action-contributors/actions/workflows/ci.yml/badge.svg)](https://github.com/jaywcjlove/github-action-contributors/actions/workflows/ci.yml)\n[![Repo Dependents](https://badgen.net/github/dependents-repo/jaywcjlove/github-action-contributors)](https://github.com/jaywcjlove/github-action-contributors/network/dependents)\n\nGithub action generates dynamic image URL for contributor list to display it!\n\nThe contributors list is fetched from [GitHub API](https://docs.github.com/cn/rest/repos/repos#list-repository-contributors).\n\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\u003ca href=\"https://github.com/jaywcjlove/github-action-contributors/graphs/contributors\"\u003e\n  \u003cimg src=\"https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg\" /\u003e\n\u003c/a\u003e\n\nWrite contributors(**`htmlTable`**) to markdown Example:\n\n\u003c!--GAMFC_TABEL--\u003e\u003ctable\u003e\u003ctr\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"100;\" alt=\"小弟调调\"/\u003e\n    \u003cbr /\u003e\u003csub\u003e\u003cb\u003e小弟调调\u003c/b\u003e\u003c/sub\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\u003c!--GAMFC_TABEL-END--\u003e\n\nBot Users:\n\n\u003c!--GAMFC_TABEL_BOTS--\u003e\u003ctable\u003e\u003ctr\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/github-actions[bot]\" title=\"github-actions[bot]\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/in/15368?v=4\" width=\"100;\" alt=\"github-actions[bot]\"/\u003e\n    \u003cbr /\u003e\u003csub\u003e\u003cb\u003egithub-actions[bot]\u003c/b\u003e\u003c/sub\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/renovate[bot]\" title=\"renovate[bot]\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/in/2740?v=4\" width=\"100;\" alt=\"renovate[bot]\"/\u003e\n    \u003cbr /\u003e\u003csub\u003e\u003cb\u003erenovate[bot]\u003c/b\u003e\u003c/sub\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\u003c!--GAMFC_TABEL_BOTS-END--\u003e\n\nCollaborators Users:\n\n\u003c!--GAMFC_TABEL_COLLABORATORS--\u003e\u003ctable\u003e\u003ctr\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"100;\" alt=\"小弟调调\"/\u003e\n    \u003cbr /\u003e\u003csub\u003e\u003cb\u003e小弟调调\u003c/b\u003e\u003c/sub\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\u003c!--GAMFC_TABEL_COLLABORATORS-END--\u003e\n\nWrite contributors(**`htmlList`**) to markdown Example:\n\n\u003c!--GAMFC--\u003e\u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"36;\" alt=\"小弟调调\"/\u003e\u003c/a\u003e\u003c!--GAMFC-END--\u003e\n\n## Usage\n\n```yml\n- run: mkdir -p build\n- name: Generate Contributors Images\n  uses: jaywcjlove/github-action-contributors@main\n  with:\n    filter-author: (renovate\\[bot\\]|renovate-bot|dependabot\\[bot\\])\n    output: build/CONTRIBUTORS.svg\n    avatarSize: 42\n\n- name: Deploy\n  uses: peaceiris/actions-gh-pages@v3\n  with:\n    github_token: ${{ secrets.GITHUB_TOKEN }}\n    publish_dir: ./build\n```\n\n```\nhttps://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg\n```\n\nUse in markdown\n\n```markdown\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\u003ca href=\"https://github.com/jaywcjlove/github-action-contributors/graphs/contributors\"\u003e\n  \u003cimg src=\"https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg\" /\u003e\n\u003c/a\u003e\n\nMade with [contributors](https://github.com/jaywcjlove/github-action-contributors).\n```\n\n\u003ca href=\"https://github.com/jaywcjlove/github-action-contributors/graphs/contributors\"\u003e\n  \u003cimg src=\"https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg\" /\u003e\n\u003c/a\u003e\n\n### Write contributors(**`htmlList`**) to markdown\n\n```yml\n- name: Generate Contributors Images\n  uses: jaywcjlove/github-action-contributors@main\n  id: contributors\n  with:\n    filter-author: (renovate\\[bot\\]|renovate-bot|dependabot\\[bot\\])\n    avatarSize: 42\n\n- name: Modify README.md\n  uses: jaywcjlove/github-action-modify-file-content@main\n  with:\n    path: README.md\n    body: '${{steps.contributors.outputs.htmlList}}'\n```\n\nUse in `README.md` markdown\n\n```markdown\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\u003c!--GAMFC--\u003e\u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"36;\" alt=\"小弟调调\"/\u003e\u003c/a\u003e\u003c!--GAMFC-END--\u003e\n\nMade with [contributors](https://github.com/jaywcjlove/github-action-contributors).\n```\n\nWrite contributors(**`htmlList`**) to markdown Example:\n\n\u003c!--GAMFC--\u003e\u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"36;\" alt=\"小弟调调\"/\u003e\u003c/a\u003e\u003c!--GAMFC-END--\u003e\n\n### Write contributors(**`htmlTable`**) to markdown\n\n```yml\n- name: Generate Contributors Images\n  uses: jaywcjlove/github-action-contributors@main\n  id: contributors\n  with:\n    filter-author: (renovate\\[bot\\]|renovate-bot|dependabot\\[bot\\])\n    openDelimiter: '\u003c!--GAMFC_DELIMITER--\u003e'\n    closeDelimiter: '\u003c!--GAMFC_DELIMITER-END--\u003e'\n    hideName: 'true' # Hide names in htmlTable\n    avatarSize: 100  # Set the avatar size.\n\n- name: Modify htmlTable README.md\n  uses: jaywcjlove/github-action-modify-file-content@main\n  with:\n    path: README.md\n    body: '${{steps.contributors.outputs.htmlTable}}'\n```\n\nUse in `README.md` markdown\n\n```markdown\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\u003c!--GAMFC_DELIMITER--\u003ewill be replaced here\u003c!--GAMFC_DELIMITER-END--\u003e\n\nMade with [contributors](https://github.com/jaywcjlove/github-action-contributors).\n```\n\nWrite contributors(**`htmlTable`**) to markdown Example:\n\n\u003c!--GAMFC_TABEL_HIDE_NAME--\u003e\u003ctable\u003e\u003ctr\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"100;\" alt=\"小弟调调\"/\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\u003c!--GAMFC_TABEL_HIDE_NAME-END--\u003e\n\nBot Users:\n\n\u003c!--GAMFC_TABEL_HIDE_NAME_BOTS--\u003e\u003ctable\u003e\u003ctr\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/github-actions[bot]\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/in/15368?v=4\" width=\"100;\" alt=\"github-actions[bot]\"/\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd align=\"center\"\u003e\n    \u003ca href=\"https://github.com/renovate[bot]\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/in/2740?v=4\" width=\"100;\" alt=\"renovate[bot]\"/\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\u003c!--GAMFC_TABEL_HIDE_NAME_BOTS-END--\u003e\n\n## Inputs\n\n- `token` - Your `GITHUB_TOKEN`. This is required. Why do we need `token`? Read more here: [About the GITHUB_TOKEN secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret). Default: `${{ github.token }}`\n- `filter-author` - Regular expression filtering'.\n- `count` - Specify the max count of contributors listed. Default list all contributors(max 100).\n- `output` - output image path. default: `CONTRIBUTORS.svg`\n- `truncate` - Truncate username by specified length, `0` for no truncate. default: `12`\n- `svgWidth` - Width of the generated SVG. default: `740`\n- `avatarSize` - Size of user avatar. default: `24`\n- `avatarMargin` - Margin of user avatar. default: `5`\n- `hideName` - Hide names in `htmlTable`\n- `userNameHeight` - Height of user name. default: `0`\n- `svgTemplate` - Template to render SVG.\n\n```xml\n\u003csvg\n  xmlns=\"http://www.w3.org/2000/svg\"\n  xmlns:xlink=\"http://www.w3.org/1999/xlink\"\n  version=\"1.1\"\n  width=\"{{ width }}\"\n  height=\"{{ contributorsHeight }}\"\n\u003e\n  \u003cstyle\u003e.contributor-link { cursor: pointer; }\u003c/style\u003e\n  {{{ contributors }}}\n\u003c/svg\u003e\n```\n\n## Outputs\n\n- `svg` svg image string: `\u003csvg xmlns....`.\n- `htmlTable` Contributor HTML \\\u003cTable\u003e form string\n- `htmlTableBots` Contributor(Bot Users) HTML \\\u003cTable\u003e form string\n- `htmlList` Contributor HTML \\\u003ca\u003e list form string\n- `htmlListBots` Contributor(Bot Users) HTML \\\u003ca\u003e list form string\n- `htmlCollaboratorsTable` Collaborators user HTML \u003cTable\u003e form string\n- `htmlCollaboratorsTableBots` Collaborators user(Bot Users) HTML \u003cTable\u003e form string\n- `htmlCollaboratorsList` Collaborators user HTML \u003ca\u003e list form string\n- `htmlCollaboratorsListBots` Collaborators user(Bot Users) HTML \u003ca\u003e form string\n\n### `htmlTable`\n\n```html\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://github.com/jaywcjlove\"\u003e\n        \u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"36;\" alt=\"jaywcjlove\"/\u003e\u003cbr /\u003e\n        \u003csub\u003e\u003cb\u003ejaywcjlove\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n```\n\n### `htmlList`\n\n```html\n\u003ca href=\"https://github.com/jaywcjlove\"\u003e\n  \u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"36;\" alt=\"jaywcjlove\"/\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/github-actions[bot]\"\u003e\n  \u003cimg src=\"https://avatars.githubusercontent.com/in/15368?v=4\" width=\"36;\" alt=\"github-actions[bot]\"/\u003e\n\u003c/a\n```\n\n## Quick Start\n\n```shell\n$ npm install\n\n$ npm run watch # Listen compile .ts files.\n$ npm run build # compile .ts files.\n```\n\n## Related\n\n- [Github Release Changelog](https://github.com/jaywcjlove/changelog-generator) Generator A GitHub Action that compares the commit differences between two branches\n- [Create Tags From](https://github.com/jaywcjlove/create-tag-action) Auto create tags from commit or package.json.\n- [Create Coverage Badges](https://github.com/jaywcjlove/coverage-badges-cli) Create coverage badges from coverage reports. (no 3rd parties servers)\n- [Create Coverage Package](https://github.com/jaywcjlove/github-action-package) Read and modify the contents of `package.json`.\n- [Generated Badges](https://github.com/jaywcjlove/generated-badges) Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)\n\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\u003c!--GAMFC--\u003e\u003ca href=\"https://github.com/jaywcjlove\" title=\"小弟调调\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1680273?v=4\" width=\"36;\" alt=\"小弟调调\"/\u003e\u003c/a\u003e\u003c!--GAMFC-END--\u003e\n\nMade with [contributors](https://github.com/jaywcjlove/github-action-contributors).\n\n## License\n\nLicensed under the MIT License.\n","funding_links":["https://ko-fi.com/jaywcjlove","https://buymeacoffee.com/jaywcjlove","https://www.paypal.me/kennyiseeyou","https://jaywcjlove.github.io/#/sponsor"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaywcjlove%2Fgithub-action-contributors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaywcjlove%2Fgithub-action-contributors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaywcjlove%2Fgithub-action-contributors/lists"}