README.md

Check pull request title

This action checks the title of a pull request to ensure it follows the Conventional Commits specification. It assumes Python, pip and Commitizen are already setup, see the setup Python action and setup Commitizen action for ready to use actions to do this.

There is also a ready-to-use workflow that uses this action.

Action inputs

Input	Description	Default
include_description	Include the pull request description in the commit message.	true

Example usage

name: Check pull request title

on:
  pull_request:

jobs:
  check_pr_title:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Python
        uses: dfinity/ci-tools/actions/setup-python@main

      - name: Setup Commitizen
        uses: dfinity/ci-tools/actions/setup-commitizen@main

      - name: Check pull request title
        uses: dfinity/ci-tools/actions/check-pr-title@main
        with:
          include_description: false