From f320d2fd00ee2dffc32f16aca1ed679c65e5fb18 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tibor=20=C5=A0imko?= <tibor.simko@cern.ch>
Date: Wed, 10 Jan 2024 16:53:01 +0100
Subject: [PATCH] ci(commitlint): addition of commit message linter (#695)

Adds commitlint to check the commit message style against agreed
conventional commits configuration.

Changes script argument values to always use linter names (e.g.
shellcheck).

Changes argument handling to allow only one checking action that can now
accept further optional arguments.
---
 .commitlintrc.yaml       | 21 ++++++++++++++
 .github/workflows/ci.yml | 30 ++++++++++++++++++--
 run-tests.sh             | 60 +++++++++++++++++++++++++---------------
 3 files changed, 86 insertions(+), 25 deletions(-)
 create mode 100644 .commitlintrc.yaml

diff --git a/.commitlintrc.yaml b/.commitlintrc.yaml
new file mode 100644
index 00000000..d0b32786
--- /dev/null
+++ b/.commitlintrc.yaml
@@ -0,0 +1,21 @@
+rules:
+  body-case: [2, always, sentence-case]
+  body-full-stop: [2, always]
+  body-leading-blank: [2, always]
+  body-max-line-length: [2, always, 72]
+  footer-leading-blank: [2, always]
+  footer-max-line-length: [2, always, 72]
+  header-max-length: [2, always, 72]
+  scope-case: [2, always, lower-case]
+  subject-case:
+    - 2
+    - never
+    - [pascal-case, sentence-case, start-case, upper-case]
+  subject-empty: [2, never]
+  subject-full-stop: [2, never, "."]
+  type-case: [2, always, lower-case]
+  type-empty: [2, never]
+  type-enum:
+    - 2
+    - always
+    - [build, chore, ci, docs, feat, fix, perf, refactor, style, test]
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 0b36a5da..d6ed168a 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,5 +1,5 @@
 # This file is part of REANA.
-# Copyright (C) 2020, 2021, 2022, 2023 CERN.
+# Copyright (C) 2020, 2021, 2022, 2023, 2024 CERN.
 #
 # REANA is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -9,6 +9,32 @@ name: CI
 on: [push, pull_request]
 
 jobs:
+  lint-commitlint:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+
+      - name: Install commitlint
+        run: |
+          npm install conventional-changelog-conventionalcommits
+          npm install commitlint@latest
+
+      - name: Check commit message compliance of the recently pushed commit
+        if: github.event_name == 'push'
+        run: |
+          ./run-tests.sh --check-commitlint HEAD~1 HEAD
+
+      - name: Check commit message compliance of the pull request
+        if: github.event_name == 'pull_request'
+        run: |
+          ./run-tests.sh --check-commitlint ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} ${{ github.event.pull_request.head.sha }}
+
     lint-shellcheck:
         runs-on: ubuntu-20.04
         steps:
@@ -17,7 +43,7 @@ jobs:
           - name: Runs shell script static analysis
             run: |
               sudo apt-get install shellcheck
-              ./run-tests.sh --check-shellscript
+              ./run-tests.sh --check-shellcheck
 
     lint-black:
         runs-on: ubuntu-20.04
diff --git a/run-tests.sh b/run-tests.sh
index 22c82b03..ec2f34bf 100755
--- a/run-tests.sh
+++ b/run-tests.sh
@@ -1,22 +1,36 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # This file is part of REANA.
-# Copyright (C) 2017, 2018, 2019, 2020, 2022 CERN.
+# Copyright (C) 2017, 2018, 2019, 2020, 2022, 2024 CERN.
 #
 # REANA is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-# Quit on errors
 set -o errexit
-
-# Quit on unbound symbols
 set -o nounset
 
-
-check_script () {
+check_shellcheck () {
     shellcheck run-tests.sh
 }
 
+check_commitlint () {
+    from=${2:-master}
+    to=${3:-HEAD}
+    npx commitlint --from="$from" --to="$to" --verbose
+    found=0
+    while IFS= read -r line; do
+        if echo "$line" | grep -qP "\(\#[0-9]+\)$"; then
+            echo "✔   PR number present in $line"
+        else
+            echo "✖   PR number missing in $line"
+            found=1
+        fi
+    done < <(git log "$from..$to" --format="%s")
+    if [ $found -gt 0 ]; then
+        exit 1
+    fi
+}
+
 check_black () {
     black --check .
 }
@@ -57,7 +71,8 @@ check_pytest () {
 }
 
 check_all() {
-    check_script
+    check_commitlint
+    check_shellcheck
     check_black
     check_flake8
     check_pydocstyle
@@ -73,18 +88,17 @@ if [ $# -eq 0 ]; then
     exit 0
 fi
 
-for arg in "$@"
-do
-    case $arg in
-        --check-shellscript) check_script;;
-        --check-black) check_black;;
-        --check-flake8) check_flake8;;
-        --check-pydocstyle) check_pydocstyle;;
-        --check-manifest) check_manifest;;
-        --check-cli-cmds) check_cli_cmds;;
-        --check-cli-api) check_cli_api;;
-        --check-sphinx) check_sphinx;;
-        --check-pytest) check_pytest;;
-        *)
-    esac
-done
+arg="$1"
+case $arg in
+    --check-commitlint) check_commitlint "$@";;
+    --check-shellcheck) check_shellcheck;;
+    --check-black) check_black;;
+    --check-flake8) check_flake8;;
+    --check-pydocstyle) check_pydocstyle;;
+    --check-manifest) check_manifest;;
+    --check-cli-cmds) check_cli_cmds;;
+    --check-cli-api) check_cli_api;;
+    --check-sphinx) check_sphinx;;
+    --check-pytest) check_pytest;;
+    *) echo "[ERROR] Invalid argument '$arg'. Exiting." && exit 1;;
+esac