chore: Improve commit and pull request title validation

* Consolidated Gitlint and conventional commit checks into a single task.
* Added a new validation step for pull request titles to ensure they followed
conventional commit format.
* Enhanced the commit validation script with improved error handling and
explicit pip package installation.
* Updated markdownlint configuration to align with new rule names.
* Corrected minor formatting inconsistencies across several markdown
documentation files.

Signed-off-by: Chmouel Boudjnah <[email protected]>

Author: chmouel

.github/pull_request_template.md

@@ -26,7 +26,7 @@ Fixes #
 - [ ] Integration tests
 - [ ] End-to-end tests
 - [ ] Manual testing
-- [ ] Note Applicable
+- [ ] Not Applicable
 
 ## ✅ Submitter Checklist
 

.markdownlint.json

@@ -1,9 +1,10 @@
 {
   "line-length": false,
   "first-header-h1": false,
-  "first-line-h1": false,
+  "first-header-heading": false,
   "no-inline-html": false,
   "MD013": false,
   "MD025": false,
+  "MD041": false,
   "descriptive-link-text": false
 }

.tekton/linter.yaml

@@ -58,47 +58,124 @@ spec:
               workingDir: $(workspaces.source.path)
               script: |
                 shellcheck $(find hack/ -type f -regex ".*sh" -print)
-            - name: gitlint
-              displayName: "Git commit linter"
+            - name: commit-validation
+              displayName: "Git commit validation (gitlint + conventional commits)"
               image: registry.access.redhat.com/ubi9/python-312
               workingDir: $(workspaces.source.path)
               script: |
                 set -euxo pipefail
+
+                # Configure git
+                git config --global user.name "Pipelines as Code"
+                git config --global user.email "[email protected]"
+                git config --global --add safe.directory $(workspaces.source.path)
+
+                # Check if this is a GitHub event
                 if [[ "{{ headers['X-Github-Event'] }}" == "" ]]; then
-                  echo "Not a GitHub event, skipping gitlint"
+                  echo "Not a GitHub event, skipping commit validation"
                   exit 0
                 fi
 
+                # Only run on pull requests
                 if [[ "{{ headers['X-Github-Event'] }}" != "pull_request" ]]; then
-                  echo "Not a pull request, skipping gitlint"
+                  echo "Not a pull request, skipping commit validation"
                   exit 0
                 fi
 
-                git config --global --add safe.directory $(workspaces.source.path)
-                git config --global user.name "Pipelines as Code"
-                git config --global user.email "[email protected]"
-                git log -1 --format=format:%s |grep -E -q '^Merge branch' && exit 0
-                pip3 install gitlint
-
-                # Check all commits between base_sha and HEAD
+                # Get base SHA and validate
                 base_sha="{{ body.pull_request.base.sha }}"
-                failed=()
+                if [[ -z "$base_sha" ]]; then
+                  echo "Base SHA is empty, cannot determine commit range"
+                  exit 1
+                fi
+
+                echo "Validating commits between $base_sha and HEAD"
+
+                # Install gitlint
+                echo "Installing gitlint..."
+                if ! pip3 install gitlint; then
+                  echo "Failed to install gitlint"
+                  exit 1
+                fi
+
+                # Define conventional commit regex
+                conv_regexp='^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\([a-z0-9-]+\))?: .+'
+
+                # Validate commits
+                gitlint_failed=()
+                conventional_failed=()
+
                 while read -r commit_hash; do
-                  echo "Checking commit: $commit_hash"
-                  if ! git log -1 --pretty=format:%B "$commit_hash" | gitlint --staged; then
-                    echo "Gitlint failed for commit: $commit_hash"
-                    failed+=("$commit_hash")
+                  if [[ -n "$commit_hash" ]]; then
+                    echo "Validating commit: $commit_hash"
+
+                    # Get commit message
+                    commit_msg=$(git log -1 --pretty=format:%s "$commit_hash")
+                    commit_body=$(git log -1 --pretty=format:%B "$commit_hash")
+
+                    # Skip merge commits
+                    if echo "$commit_msg" | grep -E -q '^Merge branch'; then
+                      echo "  Skipping merge commit: $commit_hash"
+                      continue
+                    fi
+
+                    # Run gitlint check
+                    if ! echo "$commit_body" | gitlint --staged; then
+                      echo "  Gitlint failed for commit: $commit_hash"
+                      gitlint_failed+=("$commit_hash")
+                    fi
+
+                    # Run conventional commit check
+                    if ! echo "$commit_msg" | grep -E -q "${conv_regexp}"; then
+                      echo "  Conventional commit check failed for: $commit_hash"
+                      echo "  Message: $commit_msg"
+                      conventional_failed+=("$commit_hash")
+                    fi
                   fi
                 done < <(git log "${base_sha}..HEAD" --format=format:%H --no-merges)
 
-                if [ "${#failed[@]}" -ne 0 ]; then
-                  echo "Failed commits: ${failed[@]}"
-                  exit 1
-                else
-                  echo "Gitlint completed. All commits passed."
-                  exit 0
+                # Check pull request title for conventional commit format
+                pull_request_title="{{ body.pull_request.title }}"
+                pr_title_failed=false
+                if [[ -n "$pull_request_title" ]] && ! echo "$pull_request_title" | grep -E -q "${conv_regexp}"; then
+                  echo "ERROR: Pull request title does not follow conventional commit format:"
+                  echo "  Title: $pull_request_title"
+                  pr_title_failed=true
+                fi
+
+                # Report results
+                exit_code=0
+
+                if [ "${#gitlint_failed[@]}" -ne 0 ]; then
+                  echo ""
+                  echo "ERROR: Gitlint failed for commits: ${gitlint_failed[*]}"
+                  exit_code=1
+                fi
+
+                if [ "${#conventional_failed[@]}" -ne 0 ]; then
+                  echo ""
+                  echo "ERROR: Conventional commit format failed for commits: ${conventional_failed[*]}"
+                  echo "Expected format: type(scope): description"
+                  echo "Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
+                  echo "See: https://www.conventionalcommits.org/en/v1.0.0/#summary"
+                  exit_code=1
+                fi
+
+                if [ "$pr_title_failed" = true ]; then
+                  echo ""
+                  echo "ERROR: Pull request title validation failed"
+                  echo "Expected format: type(scope): description"
+                  echo "Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
+                  exit_code=1
+                fi
+
+                if [ $exit_code -eq 0 ]; then
+                  echo ""
+                  echo "All commit validations passed successfully!"
                 fi
 
+                exit $exit_code
+
             - name: check-generated-schemas
               displayName: "Check generated OpenAPI schemas"
               image: golang:1.23
@@ -131,43 +208,6 @@ spec:
                 # check now that there are no changes in config with git
                 git diff --exit-code config/ || { echo "Error: you need to run 'make update-schemas' and commit it."; exit 1; }
 
-            - name: conventional-commits
-              displayName: "conventional commit check"
-              image: registry.access.redhat.com/ubi9/python-312
-              workingDir: $(workspaces.source.path)
-              script: |
-                set -euxo pipefail
-                git config --global --add safe.directory /workspace/source
-
-                if [[ "{{ headers['X-Github-Event'] }}" == "" ]]; then
-                  echo "Not a GitHub event, skipping gitlint"
-                  exit 0
-                fi
-
-                if [[ "{{ headers['X-Github-Event'] }}" != "pull_request" ]]; then
-                  echo "Not a pull request, skipping gitlint"
-                  exit 0
-                fi
-                base_sha="{{ body.pull_request.base.sha }}"
-
-                # make sure we have a conventional commit
-                invalid_commits=0
-                while read -r commit_msg; do
-                  if ! echo "$commit_msg" | grep -E -q '^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\([a-z0-9-]+\))?:'; then
-                    echo "ERROR: Found commit message that does not follow conventional commit format:"
-                    echo "$commit_msg"
-                    invalid_commits=$((invalid_commits + 1))
-                  fi
-                done < <(git log "${base_sha}..HEAD" --format=format:%s --no-merges)
-
-                if [ $invalid_commits -gt 0 ]; then
-                  echo "ERROR: $invalid_commits commit(s) do not follow conventional commit format."
-                  echo "Expected format: type(scope): description"
-                  echo "Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
-                  echo "See: https://www.conventionalcommits.org/en/v1.0.0/#summary"
-                  exit 1
-                fi
-
             - name: yamllint
               displayName: "YAML Linter"
               image: cytopia/yamllint

README.md

@@ -9,7 +9,7 @@ Pipelines-as-Code is an opinionated CI/CD solution built on OpenShift Pipelines
 and Tekton. It enables you to define, manage, and execute pipelines directly
 from your source code repository.
 
-📖 **Full documentation:** [pipelinesascode.com](https://pipelinesascode.com)  
+📖 **Full documentation:** [pipelinesascode.com](https://pipelinesascode.com)
 🛠️ **Development branch docs:** [here](https://nightly.pipelines-as-code.pages.dev/)
 
 ---
@@ -69,7 +69,7 @@ If you'd like to help improve Pipelines-as-Code, check out our contribution guid
 
 ## 🎥 Videos & Blogs
 
-- 📺 [OpenShift Developer Experience: Pipelines-as-Code](https://www.youtube.com/watch?v=PhqzGsJnFEI)  
+- 📺 [OpenShift Developer Experience: Pipelines-as-Code](https://www.youtube.com/watch?v=PhqzGsJnFEI)
 - 📘 [How to make a release pipeline with Pipelines-as-Code](https://blog.chmouel.com/2021/07/01/how-to-make-a-release-pipeline-with-pipelines-as-code)
 
 - 📝 **Latest Developer Documentation:** [Main branch docs](https://main.pipelines-as-code.pages.dev/)

docs/content/docs/guide/resolver.md

@@ -37,7 +37,7 @@ The resolver will skip resolving if it sees these type of tasks:
 
 * a reference to a [`ClusterTask`](https://github.com/tektoncd/pipeline/blob/main/docs/tasks.md#task-vs-clustertask)
 * a `Task` or `Pipeline` [`Bundle`](https://github.com/tektoncd/pipeline/blob/main/docs/pipelines.md#tekton-bundles)
-* a reference to a Tekton [`Resolver`](https://github.com/tektoncd/pipeline/blob/main/docs/pipelines.md#specifying-remote-tasks)  
+* a reference to a Tekton [`Resolver`](https://github.com/tektoncd/pipeline/blob/main/docs/pipelines.md#specifying-remote-tasks)
 * a [Custom Task](https://github.com/tektoncd/pipeline/blob/main/docs/pipelines.md#using-custom-tasks) with an apiVersion that doesn't have a `tekton.dev/` prefix.
 
 It just uses them "as is" and will not try to do anything with it.

docs/content/docs/install/settings.md

@@ -145,12 +145,12 @@ There is a few things you can configure through the config map
   both a push event and a pull request. If a push event comes from a commit that is
   part of an open pull request, the push event will be skipped as it would create
   a duplicate pipeline run.
-  
+
   This feature works by checking if a pushed commit SHA exists in any open pull request,
   and if so, skipping the push event processing.
-  
+
   Default: `true`
-  
+
 {{< support_matrix github_app="true" github_webhook="true" gitea="false" gitlab="false" bitbucket_cloud="false" bitbucket_datacenter="false" >}}
 
 ### Global Cancel In Progress Settings