Automatically generate or update AUTHORS.txt for your repository.
Create a workflow file such as .github/workflows/authors.yml in your repository:
name: Update Authors
on:
push:
branches:
- master
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: wow-actions/update-authors@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Various inputs are defined to let you configure the action:
Note: Workflow command and parameter names are not case-sensitive.
| Name | Description | Default |
|---|---|---|
GITHUB_TOKEN |
The GitHub token for authentication | N/A |
sort |
Sort type('alphabet' or 'commits') of authors |
'alphabet' |
bots |
Include bots or not | true |
template |
Template to render each line of authors Placeholders {{commits}}, {{name}}, {{email}} are supportted |
'{{name}} <{{email}}>' |
commit |
Commit message | 'chore: update AUTHORS [skip ci]' |
path |
Path of the AUTHORS.txt file |
'AUTHORS' |
The scripts and documentation in this project are released under the MIT License.