Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
chevron-right

GitHub Action

PR Lint

v3.2.1

PR Lint

chevron-right

PR Lint

Lint PR Titles

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: PR Lint

              
  uses: henrygriffiths/[email protected]
Learn more about this action in henrygriffiths/pr_lint

Choose a version

PR Lint

This action makes sure PR titles are linted with commitlint and project management issue keys

Examples:

One issue key: fix(deps): issue-123: fixing deps

Multiple issue keys: fix(deps): issue-123, key-1234: fixing deps

Usage

- uses: henrygriffiths/pr_lint@v3
  with:
    # Required
    # Issue Key used in project management system
    # If multiple keys are used, separate via comma (eg: keya,keyb)
    issuekey: ''
    
    # Optional
    # Manually provide PR title via actions
    # Default: ${{ github.event.pull_request.title }}
    prtitle: ''
    
    # Optional
    # Manually provide types (comma separated)
    # Default: 'build,ci,chore,docs,feat,fix,perf,refactor,revert,style,task,test'
    types: ''
    
    # Optional
    # Allow linting to pass when no issue key is provided
    # Default: true
    allownokey: true

License

This project is released under the MIT License