From 7910496851dde25a39a29cb2219756b7320a82d5 Mon Sep 17 00:00:00 2001 From: Marco Villegas Date: Mon, 15 Jan 2024 06:05:22 +0000 Subject: [PATCH 1/5] Start pre-push git hook sample --- tests/scripts/git-hooks/pre-push | 53 ++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100755 tests/scripts/git-hooks/pre-push diff --git a/tests/scripts/git-hooks/pre-push b/tests/scripts/git-hooks/pre-push new file mode 100755 index 0000000000..6187dbf439 --- /dev/null +++ b/tests/scripts/git-hooks/pre-push @@ -0,0 +1,53 @@ +#!/bin/sh + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +z40=0000000000000000000000000000000000000000 + +while read local_ref local_sha remote_ref remote_sha +do + if [ "$local_sha" = $z40 ] + then + # Handle delete + : + else + if [ "$remote_sha" = $z40 ] + then + # New branch, examine all commits + range="$local_sha" + else + # Update to existing branch, examine new commits + range="$remote_sha..$local_sha" + fi + + # Check for WIP commit + commit=`git rev-list -n 1 --grep '^WIP' "$range"` + if [ -n "$commit" ] + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 From 0a5c3b302203bafbf1e35f92b053876a6f4841da Mon Sep 17 00:00:00 2001 From: Marco Villegas Date: Mon, 15 Jan 2024 06:06:21 +0000 Subject: [PATCH 2/5] Reformat pre-push script --- tests/scripts/git-hooks/pre-push | 42 ++++++++++++++++---------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/tests/scripts/git-hooks/pre-push b/tests/scripts/git-hooks/pre-push index 6187dbf439..5377494f73 100755 --- a/tests/scripts/git-hooks/pre-push +++ b/tests/scripts/git-hooks/pre-push @@ -26,28 +26,28 @@ z40=0000000000000000000000000000000000000000 while read local_ref local_sha remote_ref remote_sha do - if [ "$local_sha" = $z40 ] - then - # Handle delete - : - else - if [ "$remote_sha" = $z40 ] - then - # New branch, examine all commits - range="$local_sha" - else - # Update to existing branch, examine new commits - range="$remote_sha..$local_sha" - fi + if [ "$local_sha" = $z40 ] + then + # Handle delete + : + else + if [ "$remote_sha" = $z40 ] + then + # New branch, examine all commits + range="$local_sha" + else + # Update to existing branch, examine new commits + range="$remote_sha..$local_sha" + fi - # Check for WIP commit - commit=`git rev-list -n 1 --grep '^WIP' "$range"` - if [ -n "$commit" ] - then - echo >&2 "Found WIP commit in $local_ref, not pushing" - exit 1 - fi - fi + # Check for WIP commit + commit=`git rev-list -n 1 --grep '^WIP' "$range"` + if [ -n "$commit" ] + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi done exit 0 From c77e4159f3b53f4ec1db4edbfb23b54923d9c65c Mon Sep 17 00:00:00 2001 From: Marco Villegas Date: Mon, 15 Jan 2024 06:15:38 +0000 Subject: [PATCH 3/5] Add coding standards check to sample git pre-push hook --- tests/scripts/git-hooks/pre-push | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/tests/scripts/git-hooks/pre-push b/tests/scripts/git-hooks/pre-push index 5377494f73..bb65c4de8f 100755 --- a/tests/scripts/git-hooks/pre-push +++ b/tests/scripts/git-hooks/pre-push @@ -23,6 +23,7 @@ remote="$1" url="$2" z40=0000000000000000000000000000000000000000 +composer=${composer-'composer'} while read local_ref local_sha remote_ref remote_sha do @@ -47,6 +48,18 @@ do echo >&2 "Found WIP commit in $local_ref, not pushing" exit 1 fi + + # Run coding standards check over modified files. + modified_files=`git diff --diff-filter=d --name-only "$range"` + if [ -n "$modified_files" ] + then + $composer phpcs $modified_files + if [ $? -ne 0 ] + then + echo >&2 "A coding standards regressions was introduced, please fix it before pushing." + exit 1 + fi + fi fi done From f99e69fa7b9a23295b3f62edb753d7c5f02e4884 Mon Sep 17 00:00:00 2001 From: Marco Villegas Date: Mon, 15 Jan 2024 06:18:53 +0000 Subject: [PATCH 4/5] Document a bit how ot setup the git pre-push script --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3af9df7662..08c9c17e4f 100755 --- a/README.md +++ b/README.md @@ -211,6 +211,12 @@ or, for Chamilo 1.11 ``` If your default php-cli uses PHP7.4 (see `ln -s /etc/alternatives/php`), you might have issues running with a so-called `platform_check.php` script when running `composer update` anyway. This is because this script doesn't user the proper launch context, and you might need to change your default settings on Ubuntu (i.e. change the link /etc/alternatives/php to point to the other php version) before launching `composer update`. You can always revert that operation later on if you need to go back to work on Chamilo 1.11 and Composer complains again. +### git hooks + +To use the git hook sample scripts under `tests/scripts/git-hooks/`, the +following commands can be used. + + git config core.hooksPath tests/scripts/git-hooks/ ## Changes from 1.x From b558a524df19d86a6b365e574e6e17cca5f8b35d Mon Sep 17 00:00:00 2001 From: Marco Villegas Date: Mon, 15 Jan 2024 06:21:40 +0000 Subject: [PATCH 5/5] Remove WIP check on git pre-push hook --- tests/scripts/git-hooks/pre-push | 8 -------- 1 file changed, 8 deletions(-) diff --git a/tests/scripts/git-hooks/pre-push b/tests/scripts/git-hooks/pre-push index bb65c4de8f..ad358cc27c 100755 --- a/tests/scripts/git-hooks/pre-push +++ b/tests/scripts/git-hooks/pre-push @@ -41,14 +41,6 @@ do range="$remote_sha..$local_sha" fi - # Check for WIP commit - commit=`git rev-list -n 1 --grep '^WIP' "$range"` - if [ -n "$commit" ] - then - echo >&2 "Found WIP commit in $local_ref, not pushing" - exit 1 - fi - # Run coding standards check over modified files. modified_files=`git diff --diff-filter=d --name-only "$range"` if [ -n "$modified_files" ]