Skip to content

A GitHub bot to label issues and PRs automatically based on keywords in the title and body.

License

Notifications You must be signed in to change notification settings

ZeWaka/KeywordLabeler

Repository files navigation

KeywordLabeler

A GitHub bot to label issues and PRs automatically based on keywords in the title and body. Built with probot and glitch.

Current version: 1.6.0

Marketplace link: https://github.com/marketplace/keywordlabeler

Installation

After installation, create a .github/keylabeler.yml file in the default branch to enable it. Example configuration:

# Determines if we search the title (optional). Defaults to true.
matchTitle: true

# Determines if we search the body (optional). Defaults to true.
matchBody: true

# Determines if label matching is case sensitive (optional). Defaults to true.
caseSensitive: false

# By default, the labeler looks for a specific string phrase.
# Therefore, this can create false positives like "fix" being found in "fixture".
# You can use regex instead to reduce those false positives. Defaults to false.
useRegex: false

# Explicit keyword mappings to labels. Form of match:label. Required.
labelMappings:
  "[WIP]": WIP
  hooks: documentation

Contributing

Read the CONTRIBUTING guide for information.

License

Licensed under ISC. See LICENSE for more information.

About

A GitHub bot to label issues and PRs automatically based on keywords in the title and body.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published