https://github.com/wow-actions/update-authors

👷🏻‍♂️ Automatically generate or update AUTHORS.txt for your repository
https://github.com/wow-actions/update-authors

authors github-actions

Last synced: 3 months ago
JSON representation

👷🏻‍♂️ Automatically generate or update AUTHORS.txt for your repository

• Host: GitHub
• URL: https://github.com/wow-actions/update-authors
• Owner: wow-actions
• License: mit
• Created: 2020-10-16T01:51:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-30T04:46:39.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T13:35:04.703Z (3 months ago)
• Topics: authors, github-actions
• Language: TypeScript
• Homepage:
• Size: 382 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Update Authors

Automatically generate or update `AUTHORS.txt` for your repository.

## Usage

Create a workflow file such as `.github/workflows/authors.yml` in your repository:

```yml

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 }}

```

## Inputs

Various inputs are defined to let you configure the action:

> Note: [Workflow command and parameter names are not case-sensitive](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).

| 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'` |

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).