Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salgado2004/contributors-chart-action
A GitHub Action that generates a HTML chart of the repository or organization contributors and places it in your README.
https://github.com/salgado2004/contributors-chart-action
action community contributions contributors-namecards nodejs readme-design utilities workflow
Last synced: about 8 hours ago
JSON representation
A GitHub Action that generates a HTML chart of the repository or organization contributors and places it in your README.
- Host: GitHub
- URL: https://github.com/salgado2004/contributors-chart-action
- Owner: Salgado2004
- License: mit
- Created: 2024-12-16T23:57:12.000Z (27 days ago)
- Default Branch: main
- Last Pushed: 2025-01-09T16:59:45.000Z (4 days ago)
- Last Synced: 2025-01-09T17:54:59.488Z (3 days ago)
- Topics: action, community, contributions, contributors-namecards, nodejs, readme-design, utilities, workflow
- Language: JavaScript
- Homepage:
- Size: 22 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Contributors README Chart Generator
A GitHub Action that generates a HTML chart of the repository or organization contributors and places it in your README.
> [!note]
> This is still a Beta version of the Action, currently in preview. If you have suggestions please refer to [contributing](CONTRIBUTING.md)
### Support
| runner | support |
| -------------- | ------- |
| windows-latest | ✅ |
| ubuntu-latest | |
| macos-latest | |
### Usage
1. In the desired repository, update the README markdown with these two (2) comments:
```markdown
```
> [!important]
> The comments are used to mark where the action should place the generated chart. Without them, the action will fail.
2. Create the GitHub Actions workflow. You need to provide a `GitHub Token` with **write** permissions
```yaml
jobs:
generate-chart:
runs-on: windows-latest
name: Create or update contributors chart
permissions:
contents: write
steps:
- uses: salgado2004/contributors-chart-action@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
3. (**Optional**) You can provide the following optional inputs for your workflow:
- `contributions` ["repo", "org"]
Allows you to choose if you want to gather the contributors for the current repository or the organization
_Default_: "repo"
> [!warning]
> If you choose "org", the action needs to run in a repository that belongs to an organization.
>
> **Also**: It only shows public members of the organization.
- `include-bots` [true, false]
Allows you to choose whether you want the action to include bot contributors (dependabot, github-actions bot, etc.) or not.
_Default_: true
- `path` [string]
Allows you to specify an alternate path to look for a README file.
_Default_: ""
- `limit` [number]
Allows you to set the maximum number of contributors you want to display in the chart.
_Default_: 24
### License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
---
**© Salgado2004**