callable-commitlint.yaml

# Copyright 2024 Defense Unicorns
# SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial

name: PR Title Check

on:
  # This workflow is triggered on pull requests to the main branch.
  pull_request:
    branches: [main]
    # milestoned is added here as a workaround for release-please not triggering PR workflows (PRs should be added to a milestone to trigger the workflow).
    types: [milestoned, opened, edited, synchronize]

  # This allows other repositories to call this workflow in a reusable way
  workflow_call:

# Permissions for the GITHUB_TOKEN used by the workflow.
permissions:
  contents: read # Allows reading the content of the repository.
  pull-requests: read # Allows reading pull requests

jobs:
  run:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: read # Allows reading pull request metadata.
      contents: read  # Allows pulling repo contents.

    steps:
      - name: Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0

      - name: Install commitlint
        run: |
          npm install --save-dev @commitlint/config-conventional@19.5.0
          npm install --save-dev @commitlint/cli@19.5.0

      - name: Lint PR title
        env:
          pull_request_title: ${{ github.event.pull_request.title }}
        run: |
          echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
          # shellcheck disable=SC2154
          echo "$pull_request_title" | npx commitlint