{"id":24167326,"url":"https://github.com/salgado2004/contributors-chart-action","last_synced_at":"2025-09-20T11:32:36.323Z","repository":{"id":268473563,"uuid":"904461936","full_name":"Salgado2004/contributors-chart-action","owner":"Salgado2004","description":"A GitHub Action that generates a HTML chart of the repository or organization contributors and places it in your README.","archived":false,"fork":false,"pushed_at":"2025-01-09T16:59:45.000Z","size":23038,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-09T17:54:59.488Z","etag":null,"topics":["action","community","contributions","contributors-namecards","nodejs","readme-design","utilities","workflow"],"latest_commit_sha":null,"homepage":"","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/Salgado2004.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-16T23:57:12.000Z","updated_at":"2025-01-07T15:36:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"3eec740c-ec8e-43be-b8ca-b07ca4062bd1","html_url":"https://github.com/Salgado2004/contributors-chart-action","commit_stats":null,"previous_names":["salgado2004/contributors-chart-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Salgado2004%2Fcontributors-chart-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Salgado2004%2Fcontributors-chart-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Salgado2004%2Fcontributors-chart-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Salgado2004%2Fcontributors-chart-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Salgado2004","download_url":"https://codeload.github.com/Salgado2004/contributors-chart-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233660123,"owners_count":18710026,"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":["action","community","contributions","contributors-namecards","nodejs","readme-design","utilities","workflow"],"created_at":"2025-01-12T21:13:06.535Z","updated_at":"2025-09-20T11:32:36.296Z","avatar_url":"https://github.com/Salgado2004.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Contributors README Chart Generator\nA GitHub Action that generates a HTML chart of the repository or organization contributors and places it in your README.\n\n\u003e [!note]\n\u003e This is still a Beta version of the Action, currently in preview. If you have suggestions please refer to [contributing](CONTRIBUTING.md)\n\n![Example 1](docs/example1.png)\n\n### Support\n\n| runner         | support |\n| -------------- | ------- |\n| windows-latest | ✅     |\n| ubuntu-latest  |         |\n| macos-latest   |         |\n\n### Usage\n1. In the desired repository, update the README markdown with these two (2) comments:\n```markdown\n\u003c!-- contributors --\u003e\n\u003c!-- /contributors --\u003e\n```\n\u003e [!important]\n\u003e The comments are used to mark where the action should place the generated chart. Without them, the action will fail.\n\n2. Create the GitHub Actions workflow. You need to provide a `GitHub Token` with **write** permissions\n\n```yaml\njobs:\n  generate-chart:\n      runs-on: windows-latest\n      name: Create or update contributors chart\n      permissions:\n        contents: write\n      steps:\n        - uses: salgado2004/contributors-chart-action@main\n          with:\n            token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n3. (**Optional**) You can provide the following optional inputs for your workflow:\n- `contributions` [\"repo\", \"org\"]\n  \n  Allows you to choose if you want to gather the contributors for the current repository or the organization\n\n  _Default_: \"repo\"\n\n\u003e [!warning]\n\u003e If you choose \"org\", the action needs to run in a repository that belongs to an organization.\n\u003e\n\u003e **Also**: It only shows public members of the organization.\n\n- `include-bots` [true, false]\n\n  Allows you to choose whether you want the action to include bot contributors (dependabot, github-actions bot, etc.) or not.\n\n  _Default_: true\n\n- `path` [string]\n\n  Allows you to specify an alternate path to look for a README file.\n\n  _Example_: \"profile\" \n  \u003e Will search the README under the folder \"profile/\"\n\n  _Default_: \"\"\n\n- `limit` [number]\n\n  Allows you to set the maximum number of contributors you want to display in the chart.\n\n  _Default_: 24\n\n### License\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n\n![Example 2](docs/example2.png)\n\n---\n\n**\u0026copy; Salgado2004**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalgado2004%2Fcontributors-chart-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalgado2004%2Fcontributors-chart-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalgado2004%2Fcontributors-chart-action/lists"}