{"id":19858772,"url":"https://github.com/wow-actions/contributors-list","last_synced_at":"2025-04-06T16:14:37.626Z","repository":{"id":48509123,"uuid":"299264848","full_name":"wow-actions/contributors-list","owner":"wow-actions","description":"🌈 Automatically generate contributors.svg for your repository","archived":false,"fork":false,"pushed_at":"2024-10-18T08:09:18.000Z","size":82933,"stargazers_count":49,"open_issues_count":4,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T15:09:24.893Z","etag":null,"topics":["contributors","github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/wow-actions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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}},"created_at":"2020-09-28T09:56:11.000Z","updated_at":"2024-11-22T00:13:22.000Z","dependencies_parsed_at":"2024-11-04T14:03:42.151Z","dependency_job_id":"9dd12ba4-f6d4-4255-b577-cdd5a5f7602d","html_url":"https://github.com/wow-actions/contributors-list","commit_stats":{"total_commits":257,"total_committers":5,"mean_commits":51.4,"dds":0.5019455252918288,"last_synced_commit":"242b53835016268d20e79eeff6f42193c02be8c8"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Fcontributors-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Fcontributors-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Fcontributors-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Fcontributors-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wow-actions","download_url":"https://codeload.github.com/wow-actions/contributors-list/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247112182,"owners_count":20885569,"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":["contributors","github-actions"],"created_at":"2024-11-12T14:24:26.846Z","updated_at":"2025-04-06T16:14:37.593Z","avatar_url":"https://github.com/wow-actions.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eContributors List\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/wow-actions/contributors-list/actions/workflows/release.yml\"\u003e\u003cimg alt=\"build\" src=\"https://img.shields.io/github/actions/workflow/status/wow-actions/contributors-list/release.yml?branch=master\u0026logo=github\u0026style=flat-square\" \u003e\u003c/a\u003e\n  \u003ca href=\"/wow-actions/contributors-list/blob/master/LICENSE\"\u003e\u003cimg alt=\"MIT License\" src=\"https://img.shields.io/github/license/wow-actions/contributors-list?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.typescriptlang.org\" rel=\"nofollow\"\u003e\u003cimg alt=\"Language\" src=\"https://img.shields.io/badge/language-TypeScript-blue.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/wow-actions/contributors-list/pulls\"\u003e\u003cimg alt=\"PRs Welcome\" src=\"https://img.shields.io/badge/PRs-Welcome-brightgreen.svg?style=flat-square\" \u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/marketplace/actions/contributors-list\" rel=\"nofollow\"\u003e\u003cimg alt=\"website\" src=\"https://img.shields.io/static/v1?label=\u0026labelColor=505050\u0026message=Marketplace\u0026color=0076D6\u0026style=flat-square\u0026logo=google-chrome\u0026logoColor=0076D6\" \u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003cstrong\u003eAutomatically generate \u003ccode\u003econtributors.svg\u003c/code\u003e for your repository\u003c/strong\u003e\u003c/p\u003e\n\n## Usage\n\nCreate a workflow file such as `.github/workflows/contributors.yml`:\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          svgPath: CONTRIBUTORS.svg\n```\n\n### Inputs\n\nVarious inputs are defined to let you configure the action:\n\n\u003e Note: [Workflow command and parameter names are not case-sensitive](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).\n\n- `sort`: Specify if sort contributors by contributions or not. Default: `true`.\n- `round`: Specify if clip the avatar to rounded or not. Default: `true`.\n- `count`: Specify the max count of contributors listed. Default list all contributors.\n- `truncate`: Truncate username by specified length, `0` for no truncate. Default: `12`.\n- `affiliation`: Specify the type of collaborators. Default: `direct`. Options: `all/direct/outside`.\n  - `'outside'`: All outside collaborators of an organization-owned repository.\n  - `'direct'`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.\n  - `'all'`: All collaborators the authenticated user can see.\n- `includeBots`: Specify if include bots in the contributors list or not. Default `true`.\n- `excludeUsers`: Users separated by space to exclude in the contributors list.\n- `svgPath`: The path to save generated SVG. Default `'CONTRIBUTORS.svg'`.\n- `svgWidth`: Width of the generated SVG. Default: `740`.\n- `avatarSize`: Size of user avatar. Default: `64`.\n- `avatarMargin`: Margin of user avatar. Default: `5`.\n- `userNameHeight`: Height of user name. Default: `0`.\n- `svgTemplate`: Template to render SVG. Default:\n  ```html\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\n      .contributor-link {\n        cursor: pointer;\n      }\n    \u003c/style\u003e\n    {{{ contributors }}}\n  \u003c/svg\u003e\n  ```\n- `itemTemplate`: Template to render user item. Default:\n  ```html\n  \u003ca\n    id=\"{{{ name }}}\"\n    title=\"{{{ name }}}\"\n    xlink:href=\"{{{ url }}}\"\n    class=\"contributor-link\"\n    target=\"_blank\"\n    rel=\"nofollow sponsored\"\n  \u003e\n    \u003cimage\n      x=\"{{ x }}\"\n      y=\"{{ y }}\"\n      width=\"{{ width }}\"\n      height=\"{{ height }}\"\n      xlink:href=\"{{{ avatar }}}\"\n    /\u003e\n  \u003c/a\u003e\n  ```\n- `commitMessage`: Commit message of the github action. Default: `'chore: update contributors'`\n- `noCommit`: Changes will not be committed. This options requires a local clone and will updated if required the contributor svg. Default: `false`.\n\n## Examples\n\n### Rounded Avatar\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          round: true\n```\n\n\u003cimg src=\"./examples/contributors-rounded-avatar.svg\"\u003e\n\n### Squared Avatar\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          round: false\n```\n\n\u003cimg src=\"./examples/contributors-squared-avatar.svg\"\u003e\n\n### With UserName\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          userNameHeight: 19\n          itemTemplate: \u003e\n            \u003cg transform=\"translate({{ x }}, {{ y }})\"\u003e\n              \u003ca xlink:href=\"{{{ url }}}\" class=\"contributor-link\" target=\"_blank\" rel=\"nofollow sponsored\" title=\"{{{ name }}}\" id=\"{{{ name }}}\"\u003e\n                \u003cimage width=\"{{ width }}\" height=\"{{ height }}\" xlink:href=\"{{{ avatar }}}\" /\u003e\n                \u003ctext x=\"32\" y=\"74\" text-anchor=\"middle\" alignment-baseline=\"middle\" font-size=\"10\"\u003e{{{ name }}}\u003c/text\u003e\n              \u003c/a\u003e\n            \u003c/g\u003e\n```\n\n\u003cimg src=\"./examples/contributors-username.svg\"\u003e\n\n### Only Bots\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          svgTemplate: \u003e\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=\"{{ botsHeight }}\"\n            \u003e\n              \u003cstyle\u003e.contributor-link { cursor: pointer; }\u003c/style\u003e\n              {{{ bots }}}\n            \u003c/svg\u003e\n```\n\n\u003cimg src=\"./examples/bots.svg\"\u003e\n\n### Only Collaborators\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          svgTemplate: \u003e\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=\"{{ collaboratorsHeight }}\"\n            \u003e\n              \u003cstyle\u003e.contributor-link { cursor: pointer; }\u003c/style\u003e\n              {{{ collaborators }}}\n            \u003c/svg\u003e\n```\n\n\u003cimg src=\"./examples/collaborators.svg\"\u003e\n\n### Contributors And Bots\n\n```yml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          includeBots: false\n          svgTemplate: |\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=\"{{#sum}} {{ contributorsHeight }} +  {{ botsHeight }} + 32 + 32 {{/sum}}\"\n            \u003e\n              \u003cstyle\u003e.contributor-link { cursor: pointer; }\u003c/style\u003e\n\n              \u003ctext x=\"5\" y=\"8\" text-anchor=\"start\" alignment-baseline=\"before-edge\" font-size=\"24\"\u003eContributors\u003c/text\u003e\n              \u003cg transform=\"translate(0, 32)\"\u003e\n                {{{ contributors }}}\n              \u003c/g\u003e\n\n              \u003ctext x=\"5\" y=\"{{#sum}} {{ contributorsHeight }} + 32 + 8 {{/sum}}\" text-anchor=\"start\" alignment-baseline=\"before-edge\" font-size=\"24\"\u003eBots\u003c/text\u003e\n              \u003cg transform=\"translate(0, {{#sum}} {{ contributorsHeight }} + 32 + 32 {{/sum}})\"\u003e\n                {{{ bots }}}\n              \u003c/g\u003e\n            \u003c/svg\u003e\n```\n\n\u003cimg src=\"./examples/contributors-bots.svg\"\u003e\n\n### Contributors, Bots And Collaborators\n\n```yaml\nname: Contributors\non:\n  schedule:\n    - cron: '0 1 * * 0' # At 01:00 on Sunday.\n  push:\n    branches:\n      - master\njobs:\n  contributors:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/contributors-list@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          includeBots: false\n          svgTemplate: |\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=\"{{#sum}} {{ contributorsHeight }} + {{ botsHeight }} + {{ collaboratorsHeight }} + 32 + 32 + 32 {{/sum}}\"\n            \u003e\n              \u003cstyle\u003e.contributor-link { cursor: pointer; }\u003c/style\u003e\n\n              \u003ctext x=\"5\" y=\"5\" text-anchor=\"start\" alignment-baseline=\"before-edge\" font-size=\"24\"\u003eContributors\u003c/text\u003e\n              \u003cg transform=\"translate(0, 32)\"\u003e\n                {{{ contributors }}}\n              \u003c/g\u003e\n\n              \u003ctext x=\"5\" y=\"{{#sum}} {{ contributorsHeight }} + 32 + 8 {{/sum}}\" text-anchor=\"start\" alignment-baseline=\"before-edge\" font-size=\"24\"\u003eBots\u003c/text\u003e\n              \u003cg transform=\"translate(0, {{#sum}} {{ contributorsHeight }} + 32 + 32 {{/sum}})\"\u003e\n                {{{ bots }}}\n              \u003c/g\u003e\n\n              \u003ctext x=\"5\" y=\"{{#sum}} {{ contributorsHeight }} + {{ botsHeight }} + 32 + 32 + 8 {{/sum}}\" text-anchor=\"start\" alignment-baseline=\"before-edge\" font-size=\"24\"\u003eCollaborators\u003c/text\u003e\n              \u003cg transform=\"translate(0, {{#sum}} {{ contributorsHeight }} + {{ botsHeight }} + 32 + 32 + 32 {{/sum}})\"\u003e\n                {{{ collaborators }}}\n              \u003c/g\u003e\n            \u003c/svg\u003e\n```\n\n\u003cimg src=\"./examples/contributors-bots-collaborators.svg\"\u003e\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwow-actions%2Fcontributors-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwow-actions%2Fcontributors-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwow-actions%2Fcontributors-list/lists"}