prcolinter/action.yml

Easily lint each commit for your PRs against the Conventional Commit spec based on configurable Linter rules.

name: prcolinter

description: Lint all PR commits in a given PR against conventional commit spec

branding:
  icon: check-circle
  color: blue

inputs:
  token:
    description: A token with access to your repository scoped in as a secret
    required: true
  config_path:
    required: false
    description: Path to configuration file
    default: './.github/prcolinterrc.json'
  rules:
    required: false
    description: 'Rule set for commit linter. For examples, see https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/config-conventional/index.js'
  comment:
    required: false
    description: Add a lint report as a comment on the PR
    default: 'true'
  delete_comment:
    required: false
    description: Whether to scrub old lint reports from comments
    default: 'true'

runs:
  using: node12
  main: dist/index.js