commitlint.yaml

name: Metadata

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:

jobs:
  validate:
    runs-on: ubuntu-latest
    name: Validate PR Title
    permissions:
      pull-requests: read # Allows reading pull request metadata.
      contents: read  # Allows pulling repo contents.

    steps:
      - name: Checkout
        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
        with:
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3

      - name: Install commitlint
        run: |
          npm install --save-dev @commitlint/config-conventional@19.2.2
          npm install --save-dev @commitlint/cli@19.3.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
          echo "$pull_request_title" | npx commitlint