danger-plugin-labels

danger-plugin-labels

Let any contributor add labels to their pull requests and issues

Usage

Install:

yarn add danger-plugin-labels --dev

At a glance:

// dangerfile.js
import { schedule } from 'danger'
import labels from 'danger-plugin-labels'

schedule(labels({
  label: ["WIP", "Ready for Review"]
}))

<!-- PULL_REQUEST_TEMPLATE.md -->

**Status (check one)**

- [ ] WIP
- [ ] Ready for Review

Now contributors even without write access to the repo can label their PR as "WIP" and "Ready for Review"!

Note: There is experimental issue support if you're using Peril and point the issue event hook to your Dangerfile. No guarantees it won't break though!

Options

labels (required)

The labels option lets you specify a whitelist of labels to apply. This can be either a map or an array:

schedule(labels({
  // A checked box with "WIP" will apply the "WIP" label
  labels: ["WIP"]
}))

schedule(labels({
  // A checked box with "WIP" will apply the "Work In Progress" label
  labels: {
    WIP: 'Work In Progress'
  }
}))

Note that the keys are case insensitive (wip, Wip and WIP in the markdown would all apply the label), but the label content isn't.

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.