# node-pr-labeler

**Repository Path**: mirrors_nodejs/node-pr-labeler

## Basic Information

- **Project Name**: node-pr-labeler
- **Description**: GitHub Action used by the nodejs/node repository to automatically label pull requests
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-19
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# node-pr-labeler

GitHub Action applying labels to [nodejs/node pull requests](https://github.com/nodejs/node/pulls) based off of files have been changed.

_Previously part of the [nodejs-github-bot](https://github.com/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

```yml
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`](.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](https://opensource.org/licenses/MIT)