nodejs / node-pr-labeler

GitHub Action used by the nodejs/node repository to automatically label pull requests

node-pr-labeler

GitHub Action applying labels to nodejs/node pull requests based off of files have been changed.

Previously part of the nodejs-github-bot. Extracted to make it easier for Node.js collaborators to maintain the label rules themselves.

Usage

Two parts are needed to make use of this Action:

1. GitHub Action Workflow triggered by pull requests opened in the target repository
2. A .yml configuration file declaring the rules for filepath -> labels

1. GitHub Action Workflow

name: Label PRs

on:
  pull_request_target:
    types: [opened]

jobs:
  label:
    runs-on: ubuntu-latest

    steps:
      - uses: nodejs/node-pr-labeler@v1
        with:
          configuration-path: .github/pr-labels.yml

2. .yml configuration with filepath -> label rules

.github/pr-labels.yml acts as an example and used in the test suite of this GitHub Action.

This configuration file is part of the using repository, allowing its collaborators to maintain the labelling rules, close to the source code they relate to.

License

MIT