Add contributors #116
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Add contributors | |
| on: | |
| schedule: | |
| - cron: '20 20 * * *' # Runs daily at 8:20 PM UTC | |
| push: | |
| branches: | |
| - main # Trigger on pushes to your 'main' branch | |
| workflow_dispatch: # Allows you to manually trigger the workflow | |
| jobs: | |
| add-contributors: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # Grant write access so the workflow can update README.md | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 # Uses the latest version of the checkout action | |
| - name: Add Contributors to README.md | |
| uses: BobAnkh/add-contributors@master # The action to add contributors | |
| with: | |
| CONTRIBUTOR: '### Contributors' # The exact heading the action will look for in your README.md | |
| COLUMN_PER_ROW: '6' # Number of contributor avatars per row | |
| ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Automatically provided token for authentication | |
| IMG_WIDTH: '100' # Width of the contributor avatar images | |
| FONT_SIZE: '14' # Font size for contributor names | |
| PATH: 'README.md' # The file where the contributors list will be inserted | |
| COMMIT_MESSAGE: 'docs(README): update contributors [skip ci]' # The commit message for the update, [skip ci] prevents re-triggering other workflows | |
| AVATAR_SHAPE: 'round' # Shape of the contributor avatars |