JoshuaKGoldberg / all-contributors-auto-action

Fills in missing allcontributors entries for a repository. 👪

All Contributors Auto Action

Fills in missing allcontributors entries for a repository. 👪

Usage

This action will:

1. Ask all-contributors-for-repository to collect the current repository's contributors
2. Post @all-contributors add bot comments in the newest issues and PRs for each contributor

Warning This tool only sees contributions that can be detected from the last 500 events in GitHub's API. Don't forget to manually add in other forms of contributions!

For example, the following job will run on every push to main:

# .github/workflows/contributors.yml
jobs:
  contributors:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: JoshuaKGoldberg/all-contributors-auto-action@v0.3.2

name: Contributors

on:
  push:
    branches:
      - main

...and will post comments like the following automatically:

@all-contributors please add @JoshuaKGoldberg for code.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.

Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.

...and of course, thank you for contributing! 💙

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md. Thanks! 💖

Contributors

John Reilly 🤔

Josh Goldberg 🔧

💙 This package is based on @JoshuaKGoldberg's create-typescript-app.