Label-based Reviewer Auto-assign Action

Toshimaru — Wed, 08 Dec 2021 18:56:22 +0000

My Workflow

Want to assign a reviewer based on a label❓

Here's my GitHub Action: https://github.com/toshimaru/label-actions

Submission Category:

🔧 Maintainer Must-Haves

Yaml File or Link to Code

`.github/workflows/label-actions.yml`

Your main workflow definition:

name: 'Label Actions'

on:
  pull_request:
    types: [labeled, unlabeled]

jobs:
  job:
    runs-on: ubuntu-latest
    steps:
      - uses: toshimaru/label-actions
        with:
          github-token: ${{ github.token }}
          process-only: 'prs'

`.github/label-actions.yml`

Your label-action configuration.

'review wanted':
  prs:
    reviewers:
      - toshimaru
      - github-username1
      - github-username2
      - github-username3
      - github-username4
      - github-username5
    number-of-reviewers: 2 # default is 1

toshimaru / label-actions

🤖 GitHub Action that performs certain actions when issues or pull requests are labeled or unlabeled

Label Actions

Label Actions is a GitHub bot that performs certain actions when issues or pull requests are labeled or unlabeled.

How It Works

The bot performs certain actions when an issue or pull request is labeled or unlabeled. No action is taken by default and the bot must be configured. The following actions are supported:

Post comments
Add labels
Remove labels
Close threads
Reopen threads
Lock threads with an optional lock reason
Unlock threads
Assign reviewers

Usage

Create the .github/workflows/label-actions.yml workflow file, use one of the example workflows to get started
Create the .github/label-actions.yml configuration file based on the example below
Start labeling issues and pull requests

Inputs

The bot can be configured using input parameters.

github-token
- GitHub access token, value must be ${{ github.token }} or an encrypted secret that contains a personal access token
- Optional, defaults to ${{ github.token }}
config-path
- Configuration file path
- Optional, defaults…

View on GitHub

Additional Resources / Info

Real-world use case: labeler + label-action

You can automate reviewer assign based on the code you change.

labeler adds a label based on the path of the changed files
label-action is triggered by the label added by labeler
label-action assigns a reviewer based on the label

GitHub official reviewer assignment feature

GitHub also provides a feature of auto reviewer assignment.

Managing code review settings for your team - GitHub Docs

If you want to assign a reviewer based on the team, This fits you!

This is a fork repo

This project is a fork of dessant/label-actions. Special thanks to original author, dessant! ❤️

Assign pull request author automatically with GitHub Actions

Toshimaru — Sat, 15 Aug 2020 04:08:56 +0000

My Workflow

Who should be the assignee of Pull Request ❓

In most cases, the Pull Request author should be assigned as an assignee.

My workflow, named Auto Author Assign, assigns PR author automatically when PR is opened.

Submission Category:

Maintainer Must-Haves

Auto Author Assign makes it easy for OSS maintainer to assign someone to PR and filter PR from the list.

Yaml File or Link to Code

.github/workflows/auto-author-assign.yml:



name: 'Auto Author Assign'

on:
  pull_request_target:
    types: [opened, reopened]

jobs:
  assign-author:
    runs-on: ubuntu-latest
    steps:
      - uses: toshimaru/auto-author-assign@v1.1.0
        with:
          repo-token: "${{ secrets.GITHUB_TOKEN }}"

Source code:

toshimaru / auto-author-assign

GitHub Actions: Automatically assign pull request authors.

auto-author-assign

GitHub Actions: Automatically assign pull request authors.

Why this action?

In most cases, the pull request author should be assigned as an assignee of the pull request.

This action automatically assigns the pull request author as an assignee.

Usage

# .github/workflows/auto-author-assign.yml
name: Auto Author Assign

on:
  pull_request_target:
    types: [ opened, reopened ]

permissions:
  pull-requests: write

jobs:
  assign-author:
    runs-on: ubuntu-latest
    steps:
      - uses: toshimaru/auto-author-assign@v2.1.1

Use your own token

You can specify your own token.

jobs:
  assign-author:
    runs-on: ubuntu-latest
    steps:
      - uses: toshimaru/auto-author-assign
        with:
          repo-token: ${{ secrets.YOUR_TOKEN }}

If not specified, GITHUB_TOKEN will be used by default.

Enable auto-author-assign for issues

An issue's author can be automatically assigned as an issue assignee.

Add issues to the trigger
Add issues: write to the permissions

on
  issues:
    types: [ opened, reopened ]

…

View on GitHub

Additional Resources / Info

I use this action on my project: RailsTwitterClone

DEV Community: Toshimaru

Label-based Reviewer Auto-assign Action

My Workflow

Submission Category:

Yaml File or Link to Code

`.github/workflows/label-actions.yml`

`.github/label-actions.yml`

More details on README

toshimaru / label-actions

🤖 GitHub Action that performs certain actions when issues or pull requests are labeled or unlabeled

Label Actions

How It Works

Usage

Inputs

Additional Resources / Info

Real-world use case: labeler + label-action

GitHub official reviewer assignment feature

This is a fork repo

Assign pull request author automatically with GitHub Actions

My Workflow

Submission Category:

Yaml File or Link to Code

toshimaru / auto-author-assign

GitHub Actions: Automatically assign pull request authors.

auto-author-assign

Why this action?

Usage

Use your own token

Enable auto-author-assign for issues

Additional Resources / Info