Update Contributors

Automatically update contributors field of package.json for your repository

Usage

Create a workflow file such as .github/workflows/contributors.yml:

name: Contributors
on:
  schedule:
    - cron: '0 1 * * 0' # At 01:00 on Sunday.
  push:
    branches:
      - master
jobs:
  contributors:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/update-contributors@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          includeBots: true

Inputs

Various inputs are defined to let you configure the action:

Note: Workflow command and parameter names are not case-sensitive.

sort: Specify if sort contributors by contributions or not. Default: true.
count: Specify the max count of contributors listed. Default list all contributors.
affiliation: Specify the type of collaborators. Default: direct. Options: all/direct/outside.
- 'outside': All outside collaborators of an organization-owned repository.
- 'direct': All collaborators with permissions to an organization-owned repository, regardless of organization membership status.
- 'all': All collaborators the authenticated user can see.
includeCollaborators: Specify if include collaborators or not. Default true.
includeBots: Specify if include bots in the contributors list or not. Default true.
excludeUsers: Users separated by space to exclude in the contributors list.
commitMessage: Commit message of the github action. Default: 'chore: update contributors'