https://github.com/lekterable/branchlint-action

Lint your git branch names using github action.
https://github.com/lekterable/branchlint-action

action actions branch branchlint github lint name

Last synced: 6 days ago
JSON representation

Lint your git branch names using github action.

• Host: GitHub
• URL: https://github.com/lekterable/branchlint-action
• Owner: lekterable
• License: mit
• Created: 2020-04-19T00:51:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-29T19:39:40.000Z (about 2 years ago)
• Last Synced: 2026-03-24T18:17:03.764Z (17 days ago)
• Topics: action, actions, branch, branchlint, github, lint, name
• Language: TypeScript
• Homepage:
• Size: 401 KB
• Stars: 10
• Watchers: 1
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Branchlint ![CI](https://github.com/lekterable/branchlint-action/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/lekterable/branchlint-action/branch/master/graph/badge.svg)](https://codecov.io/gh/lekterable/branchlint-action) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![management: perfekt👌](https://img.shields.io/badge/management-perfekt👌-red.svg?style=flat-square)](https://github.com/lekterable/perfekt)

Lint your Git branch names using GitHub action.

## Usage

```yaml

name: Branchlint

on: pull_request

jobs:

  lint:

    runs-on: ubuntu-latest

    steps:

      - name: Lint branch name

        uses: lekterable/branchlint-action@2.1.0

        with:

          allowed: |

            development

            /(epic|feat|fix|chore)/DEV-\d{4}/i

          errorMessage: 'Custom error message'

          startAfter: '2021-01-01 00:00:00'

```

**_allowed_** - _(required)_ a list of allowed branch names (strings and/or regular expressions) separated by a new line

**_errorMessage_** - _(optional)_ a custom error message

**_startAfter_** - _(optional)_ a date string (YYYY-MM-DD hh:mm:ss) after which the linting will start

## License

[MIT](LICENSE)