Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.28 KB

README.md

File metadata and controls

59 lines (43 loc) · 2.28 KB
Raw

About

Github Action to check the specified string, e.g. Github PR title, for work-in-progress ("WIP") patterns using regular expressions in BASH.

Usage

Simple with Defaults

Uses ^[[:space:]]*(WIP)+(:)* regex pattern to match against the PR title.

name: Check "WIP" in PR Title

on:
  pull_request:
    types: [opened, synchronize, reopened, edited]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: Check WIP in PR Title
        uses: embano1/wip@v2

Custom Options

name: Check "WIP" in PR Title

on:
  pull_request:
    types: [opened, synchronize, reopened, edited]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: Check WIP in PR Title
        uses: embano1/wip@v2
        with:
          # this is also the default value
          title: "${{ github.event.pull_request.title }}"

          # only matches PRs where title is exactly "WIP"
          regex: "^WIP$"

Configuration Options

Input Type Required Default Description
title string yes ${{ github.event.pull_request.title }} The title to perform regular expression pattern matching against. Typically a field from the Github context is used.
regex string yes ^[[:space:]]*(WIP)+(:)* The regular expression to perform. The default value matches the word WIP (optionally followed by :) and ignores any whitespace character(s) at the beginning of the text.

Note
Currently regular expression pattern matching is case-insensitive, i.e., wip would also match.