check-pr-title.yaml

---
  name: check 📓

  on:
    pull_request_target:
      types:
        - opened
        - edited
        - synchronize

  jobs:
    main:
      name: validate PR title
      runs-on: ubuntu-latest
      permissions:
        pull-requests: write
        statuses: write
        contents: read
      steps:
        - uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0
          id: lint_pr_title
          env:
            GITHUB_TOKEN: ${{ github.token }}
          with:
            types: |
              fix
              feat
              docs
              ci
              chore
            requireScope: false
            wip: true

        - uses: marocchino/sticky-pull-request-comment@v2.9.0
          # When the previous steps fails, the workflow would stop. By adding this
          # condition you can continue the execution with the populated error message.
          if: always() && (steps.lint_pr_title.outputs.error_message != null)
          with:
            header: pr-title-lint-error
            GITHUB_TOKEN: ${{ github.token }}
            message: |
              Hey there and thank you for opening this pull request! 👋🏼

              We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.

              If your PR is still a work in progress, please prefix the title with "[WIP]".

              Details:

              ```
              ${{ steps.lint_pr_title.outputs.error_message }}
              ```

        # Delete a previous comment when the issue has been resolved
        - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
          uses: marocchino/sticky-pull-request-comment@v2.9.0
          with:
            header: pr-title-lint-error
            GITHUB_TOKEN: ${{ github.token }}
            delete: true