Differences

This shows you the differences between two versions of the page.

--- git_hooks [2017/10/18 18:52] – admin
+++ git_hooks [2017/12/20 01:34] (current) – admin
@@ Line 3: / Line 3: @@
 ===== pre-receive Hook (Server-Side) =====
-This is a hook i use along with Gitlab. Its global and will be triggerd for all repositories when data ist send to the server.
+This is a hook i use along with Gitlab. Its global and will be triggerd for all repositories when data is send to the server. When data is send to the server old and new revs will be compared depending on the changed files. If the changed files contain a file named <code>.do_not_merge__WHAT-EVER-YOUR-BRANCH-IS</code> the hook will check if the branch you are pushing to **is not equal** to **WHAT-EVER-YOUR-BRANCH-IS** and will refuse to merge.
-For Gitlab Omnibus installations place 'pre-receive' file in this Folder (if it does not exist, create it)
-  /opt/gitlab/embedded/service/gitlab-shell/hooks/pre-receive.d/
-Make sure the file ist executable using 'chmod +x pre-receive'
+In case **WHAT-EVER-YOUR-BRANCH-IS** is equal to the branch you try to push to the merge will not be refuse. This is because we want to be able to create the .do_not_merge file where necessary.
-<code bash pre-receive>
+==== Setup ====
-#!/bin/sh
-read oldrev newrev refname wusel
+For Gitlab Omnibus installations place ''pre-receive'' file in this Folder (if it does not exist, create it)
+''/opt/gitlab/embedded/service/gitlab-shell/hooks/pre-receive.d/''
-merges=`git log --oneline --merges $oldrev..$newrev`
+Make sure the file ist executable using ''chmod +x pre-receive''
-readarray -t COMMIT <<< "$merges"
+==== How it works ====
-if [ -z "$COMMIT" ]; then
+The branch you do not want to be merged in any other branch create a file named <code>.do_not_merge__THE-BRANCH-NAME</code>
-    # IF ARRAY EMPTY
+Make sure **THE-BRANCH-NAME** its exactly the same name as the Branch.
-    echo ">>>>>" $COMMIT "<<<<<"
-    exit 1
-else
-    # IF MERGE EXISTS
-    for i in "$COMMIT"
-    do
-        REGEX_MERGE_DEVELOP="\bMerge.*?.branch.*?.develop\b"
+Given you have the branch ''develop'' and want to avoid merge into any other branch, simply create a file named <code>.do_not_merge__develop</code>
+==== Expected output in CLI ====
+{{::hook-pre-receive-acoid-merge.png?800|}}
+==== The Hook ====
+<code ruby pre-receive>
+#!/opt/gitlab/embedded/bin/ruby --disable-gems
+# Fix the PATH so that gitlab-shell can find git-upload-pack and friends.
+ENV['PATH'] = '/opt/gitlab/bin:/opt/gitlab/embedded/bin:' + ENV['PATH']
+require 'net/http'
+require 'json'
+require 'cgi'
+###################
+# General variables
+###################
+refs = $stdin.read
+key_id = ENV.delete('GL_ID')
+proto = $stdin
+protocol = ENV.delete('GL_PROTOCOL')
+repo_path = Dir.pwd
+gl_repository = ENV['GL_REPOSITORY']
+# Read given hashes
+hash = refs.split(' ')
+hash_from = hash[0]
+hash_to = hash[1]
+@branch = hash[2]
+#################
+# Colorize output
+#################
+class String
+    def red;            "\033[31m#{self}\033[0m" end
+    def green;          "\033[32m#{self}\033[0m" end
+    def blue;           "\033[34m#{self}\033[0m" end
+end
+##########################
+# Pull a Chuck Norris Joke
+##########################
+def get_joke(author = '')
+    begin
+        plain_uri = 'http://api.icndb.com/jokes/random'
+        url = URI.parse(plain_uri)
+        req = Net::HTTP::Get.new(url.to_s)
-        if [[ $COMMIT =~ $REGEX_MERGE_DEVELOP ]];
+        res = Net::HTTP.start(url.host, url.port) {|http|
-        then
+            http.request(req)
+        }
-            echo -e "☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️"
+        joke = CGI.unescapeHTML(JSON.parse(res.body)['value']['joke'])
-        	echo -e "\e[31m"
-        	echo -e "Please do not merge 'develop' into any other branch \e[0m"
+    rescue StandardError
-        	echo -e "Review your commit:"
+    	joke = "Chuck Norris never sleeps? Well, even Chuck Norris needs a power nap every once in a while ..."
-        	echo -e ""
+    end
-            for i in "$COMMIT"
+    return joke
-            do
+end
-            	echo -e "  $COMMIT"
-            done
+# Get changed files between hashes - check if commits contain file named '.do_not_merge'
+changed_files = `git diff --name-only --stat #{hash_from}..#{hash_to}`.chop
-        	echo -e ""
+do_not_merge = changed_files.split(/\n/)
-            echo -e "☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️"
+##################################################
-        	exit 1
+# Check if this is the .do_not_merge__ORIGIN Branch
-        else
+##################################################
-            exit 0
+def is_not_origin_branch(origin_branch)
-        fi
+    current_branch = @branch.split(/\//).last
-    done
+    origin_branch = origin_branch.split(/__/).last
-fi
+    return current_branch != origin_branch
-</code>
+end
+######################################
+# Decide whether to ban or not to ban
+######################################
+do_not_merge.each do |file|
+    if (file[/^.do_not_merge__/])
+        if(is_not_origin_branch(file))
+            puts "☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️"
+            puts get_joke().blue
+            puts ""
+            puts "The file #{file} stops you from pushing your changes to remote.".red
+            puts "You don't want to commit your changes done in DO_NOT_MERGE Branch to master or any other Branch.".red
+            puts ""
+            puts "To reset your branch use 'git reset --hard origin/#{@branch.split(/\//).last}'. This will reset your Branch to the state of the origin/remote branch"
+            puts "\n☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️  ☠️"
+            exit 1
+        end
+    end
+end                                                                                                                                                                </code>
+==== ToDo ====
+  * Find a way to make hook output look pretty in Gitlab {{::gitlab-hook-pre-receive-avoid-merge.png?800|}}

Differences

Page Tools