semantic-pull-request.yml

# https://help.github.com/en/categories/automating-your-workflow-with-github-actions

name: "Semantic Pull Request"

on: # yamllint disable-line rule:truthy
    pull_request_target:
        types:
            - "opened"
            - "reopened"
            - "edited"
            - "synchronize"

permissions: {}

jobs:
    main:
        permissions:
            pull-requests: "write" # to analyze PRs (amannn/action-semantic-pull-request)
            statuses: "write" # to mark status of analyzed PR (amannn/action-semantic-pull-request)
        runs-on: "ubuntu-latest"
        name: "Semantic Pull Request"
        steps:
            - name: "Harden Runner"
              uses: "step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895" # v2.6.1
              with:
                  egress-policy: "audit"

            - name: "Validate PR title"
              id: "lint_pr_title"
              uses: "amannn/action-semantic-pull-request@e9fabac35e210fea40ca5b14c0da95a099eff26f" # v5.4.0
              env:
                  GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
              with:
                  types: |
                      build
                      chore
                      ci
                      deps
                      docs
                      feat
                      fix
                      perf
                      refactor
                      revert
                      security
                      style
                      test
                      translation

            - uses: "marocchino/sticky-pull-request-comment@efaaab3fd41a9c3de579aba759d2552635e590fd" # v2.8.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"
                  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.

                      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@efaaab3fd41a9c3de579aba759d2552635e590fd" # v2.8.0
              with:
                  header: "pr-title-lint-error"
                  message: |
                      Thank you for following the naming conventions! 🙏