/label-regex

Github Action to put label base on field and regex

Primary LanguageJavaScript

label-regex

Github Action to put label base on a pull request field and regex.

This action will use a regex to automatically create and assign label to a Pull Request. It can be useful when working with ticket number or pattern for naming branch of PR title.

Variables

Variable Required Default Possible values Description
field true title, body, branch With what the regex will be performed on.
regex true Any valide regex that return a group The regex to match with the field. Example: ([A-Z]+?)-, will match PR title: FIX-1234 My awsome bug fix => FIX
lowercase false false true, false Force to lowercase the match for the label name
token false ${{ github.token }} A private Github access token

Example of action config

on:
  pull_request:
    types: [opened, edited]

jobs:
  label_regex:
    runs-on: ubuntu-latest
    name: Add label
    steps:
      - name: "Assign label to new Pull Request"
        uses: Bhacaz/label-regex@v2
        with:
          field: title
          regex: '([A-Z]+?)-'
          lowercase: true
          token: ${{ github.token }}