merge_group,pull_request.commitlint.yaml

# Copyright 2024
#
# Everyone is permitted to copy, distribute, modify, merge, sell, publish,
# sublicense or whatever the fuck they want with this software but at their
# OWN RISK.
# The author has absolutely no fucking clue what the code in this project
# does. It might just fucking work or not, there is no third option.
#
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
---
name: 💚 Validate Commit Compliancy

on:
  merge_group: {}
  pull_request: {}

permissions: {}

jobs:
  commitlint:
    name: ✅ Validate commits message format
    runs-on: ubuntu-22.04
    steps:
      - name: ⬇️ Checkout repository
        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
        with:
          fetch-depth: 0

      - name: 🚧 Prepare NodeJS environment
        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
        with:
          cache: npm
      - name: 🚧 Install all dependencies
        run: npm ci

      - name: ✅ Validate all PR commits
        if: github.event_name == 'pull_request'
        run: |
          npx commitlint \
            --from "${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }}" \
            --to "${{ github.event.pull_request.head.sha }}" \
            --verbose

      # NOTE: This is a workaround to make commitlint required on PRs but optional on merge groups
      - name: 🙈 Allow merge group to pass
        if: github.event_name == 'merge_group'
        run: exit 0