Git - Validate commit message - git hooks

Sakthivel Balasubramaniam — Fri, 14 May 2021 10:28:38 +0000

To enforce commit messages in git repo to follow specific format or pattern. This can be achieve by using git-hooks, where the commit message is formatted with the help of commit-msg hook. commit-msg hook will be trigger on each commit.

First go to git repo which needs the validator, then create commit-msg hook file in .git/hooks folder

cd <path-to-git-repo-to-install-commit-message-validator>

touch .git/hooks/commit-msg

Modify permission to make the hook executable

chmod +x .git/hooks/commit-msg

Open commit-msg file in a editor and add the following lines of script.

#!/usr/bin/env ruby
message_file = ARGV[0]
message = File.read(message_file)
$regex = /((\w):\s(\w))/i 
if !$regex.match(message) 
  puts "[POLICY] Your message is not formatted correctly" 
  puts "[STANDARD] Your message should be in the format: ‘committer_name: commit message’" 
  exit 1
end

Create hook installer

A simple hook installer can be created as follows, here I have used quite a complex pattern.

Customize the $regex found in the script as per need. Existing regex is designed to handle PROJECT-#### [committer_name_1|committer_name_2] commit message pattern, which can be replaced.

To install commit-msg-validator.sh use the following commands

cd <path-to-git-repo-to-install-commit-message-validator>

wget https://raw.githubusercontent.com/ImShakthi/hackrator/master/git-hooks/commit-msg-validator.sh

chmod +x commit-msg-validator.sh

sh commit-msg-validator.sh

Hola, commit message validator would be installed successfully.

PlantUML is awesome

Sakthivel Balasubramaniam — Sun, 08 Sep 2019 09:37:14 +0000

This post is all about why I felt PlantUML is awesome.

PlantUML is an open-source tool allowing users to create UML diagrams from a plain text language.

You can just write few lines of code to draw your UML diagram. UML diagrams are very important in communicating design implementation, doing these digrams in draw.io or something drawing tool is a time taking task. Playing with touchpad/mouse for long time is less effective.

I have used similar tools in past, like mermaid and graphviz.

Following are the things that made PlantUML different

Readability
Maintainable
Flexible
Powerful
Customable

Once the UML is designed with plantUML the end result can be extracted out into PNG or SVG. There are plugins that can be easily intergated into IDE's, such as PlantUML for VS Code and PlantUML for IntelliJ.

Also available for Confluence(document manager of Atlassian suite) where the history of the change in design implementation can be tracked easily PlantUML for Confluence

PS: PlantUML is written is java with graphviz underhood :)

PlantUML is a component that allows to quickly write :

Sequence diagram
Usecase diagram
Class diagram
Activity diagram (here is the legacy syntax)
Component diagram
State diagram
Object diagram
Deployment diagram beta
Timing diagram beta

You can find the details documentation of how and what is plantUML.

Here I took a random sequence diagram from internet and tried to replicate the same in PlantUML with few tweeks, the end result was wow!

Sample Sequence diagram

Sequence diagram with PlantUML

It's not just a replica, but a much better one.

Here the code that did the magic for us.

@startuml
header Facebook Authentication System
title Facebook Authentication System
footer Page no %page% of %lastpage%

actor user #3c5a99
participant WebBrowser as "Web Browser"
box "Facebook server"
    participant App as "Application"
    participant AuthZ as "Authorization System"
    database FCS as "Facebook Content System"
end box

== Basic flow ==

activate user
user -> WebBrowser : get FB resource
    activate WebBrowser
        WebBrowser -> App : request FB access
        WebBrowser <-- App : <<http redirect>>
        WebBrowser -[#red]> AuthZ : authorize
        WebBrowser <-- AuthZ : permission form
        user <-- WebBrowser : permission form
    deactivate WebBrowser

    user -> WebBrowser : user permission
    activate WebBrowser
        WebBrowser -> AuthZ : process permission
        ... 5 minutes alter ...
        WebBrowser <-- AuthZ : <<http redirect>>

        == Authorization ==
        alt permission granted
            activate App
                group
                WebBrowser -> App : FB authorization code
                        activate AuthZ
                            App ->  AuthZ : FB authorization code
                            App <--  AuthZ : FB authorization code
                        deactivate AuthZ

                        activate FCS
                            App -> FCS : access FB user protected resource
                            App <-- FCS : user protected resource
                            note left FCS: Check with content system
                        deactivate FCS
                 end
            deactivate App

            WebBrowser <-- App : user protected resource
            deactivate WebBrowser

            user <-- WebBrowser  : user protected resource
        else permission not granted
            activate WebBrowser
                activate App
                    WebBrowser -> App : no authorization
                    WebBrowser <-- App : FB resource not available
                deactivate App
            deactivate WebBrowser

            user <-- WebBrowser  : FB resource not available
        end
    deactivate WebBrowser

deactivate user
@enduml

Thanks for reading!!!
:)

Forem: Sakthivel Balasubramaniam

Git - Validate commit message - git hooks

Create hook installer

PlantUML is awesome

Sample Sequence diagram

Sequence diagram with PlantUML