feat: added pom check hooks

Author: gerardnico

.pre-commit-hooks.yaml

@@ -5,6 +5,8 @@
     A Pull Request should be used
   entry: git-hooks/prevent-commit-on-default
   language: script
+  pass_filenames: false
+  always_run: true
   stages: [ pre-commit ]
   minimum_pre_commit_version: 3.2.0
 - id: prevent-out-of-sync-commit
@@ -14,6 +16,8 @@
     A pull should be done first
   entry: git-hooks/prevent-out-of-sync-commit
   language: script
+  pass_filenames: false
+  always_run: true
   stages: [ pre-commit ]
   minimum_pre_commit_version: 3.2.0
 - id: git-fetch
@@ -25,3 +29,12 @@
   pass_filenames: false
   always_run: true
   stages: [ pre-commit ]
+- id: check-pom-xml
+  name: check maven pom
+  description: |
+    Check a maven pom file
+  entry: git-hooks/check-pom-xml
+  language: script
+  pass_filenames: false
+  files: 'pom\.xml'
+  stages: [ pre-commit ]

README.md

@@ -212,7 +212,7 @@ In your scripts, you can use the following env:
 
 The `pre-commit`:
 
-* config is part of the template at [.pre-commit-config.yaml](copier-template/.pre-commit-config.yaml)
+* config is part of the template at [.pre-commit-config.yaml](copier-template/.pre-commit-config.yaml.jinja2)
 * setup is performed with direnv via [.envrc](copier-template/.envrc.jinja2)
 * extra `git hooks` are available at [git-hooks](git-hooks)
 

copier-template/.github/dependabot.yml.jinja2

@@ -6,7 +6,7 @@ updates:
   - package-ecosystem: "maven"
     directory: "/"
     schedule:
-      interval: daily
+      interval: weekly
     ignore:
       - dependency-name: "org.slf4j:*"
       - dependency-name: "org.apache.logging.log4j:*"

copier-template/.pre-commit-config.yaml …-template/.pre-commit-config.yaml.jinja2copier-template/.pre-commit-config.yaml renamed to copier-template/.pre-commit-config.yaml.jinja2 copier-template/.pre-commit-config.yaml renamed to copier-template/.pre-commit-config.yaml.jinja2

@@ -36,10 +36,14 @@ repos:
         additional_dependencies: [ '@commitlint/config-conventional' ]
         args: [ "--verbose", "--config", ".config/commitlint.config.js" ]
   - repo: https://github.com/combostrap/devfiles
-    rev: v0.1.1
+    rev: v0.1.2 # devfiles
     hooks:
       - id: prevent-out-of-sync-commit
         name: prevent out-of-sync branch commit
+{%- if package_manager == 'maven' %}
+      - id: check-pom-xml
+        name: check pom.xml file
+{%- endif %}
   - repo: https://github.com/editorconfig-checker/editorconfig-checker
     rev: c9d5ed0 # v3.4.1
     hooks:

git-hooks/check-pom-xml

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# A hook to check for any error in a pom.xml file
+
+set -TCEeuo pipefail
+
+# validate the project is correct and all necessary information is available
+# https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
+if ! ./mvnw validate -Dorg.slf4j.simpleLogger.defaultLogLevel=warn; then
+  echo "mvn validate command failed"
+  exit 1
+fi
+# Unfortunately, missing version is a warning, not an error
+EFFECTIVE_POM=/tmp/effective-pom.xml
+# No warning, no error
+if ! LOG=$(./mvnw help:effective-pom -Dorg.slf4j.simpleLogger.defaultLogLevel=warn -Doutput="$EFFECTIVE_POM"); then
+  printf 'Error mvn effective command failed\n%s' "$LOG"
+  exit 1
+fi
+if [ "$LOG" != "" ]; then
+  printf 'Error or warning seen in pom.xml file:\n%s' "$LOG"
+  exit 1
+fi

release

@@ -13,7 +13,13 @@ export GIT_CLIFF__BUMP__INITIAL_TAG=v0.1.0 # by default it's 0.1.0
 next_version=$(git cliff --unreleased --bump "$bump_type" --context  --tag-pattern "v[0-9]+\\.[0-9]+\\.[0-9]+" | jq -r '.[0].version' | tr -d "v")
 
 # Update in-place the version
-yq -i "(.repos[] | select(.repo | match(\".*$ORGANISATION_PATH_NAME/devfiles$\")) | .rev) = \"v$next_version\"" copier-template/.pre-commit-config.yaml
+# Backup: Bad in place update will empty the file
+cp copier-template/.pre-commit-config.yaml.jinja2 /tmp/.pre-commit-config.yaml.jinja2.bak
+if ! sed -i "s/rev: .*# devfiles/rev: v$next_version #devfiles/; t; Q1" copier-template/.pre-commit-config.yaml.jinja2; then
+  echo "Substitution has not substituted anything"
+  cp /tmp/.pre-commit-config.yaml.jinja2.bak copier-template/.pre-commit-config.yaml.jinja2
+  exit 1
+fi
 git-commit "chore: release $next_version"
 
 echo "Releasing to the version $next_version"