DEV Community: Anibal

How to check commit message and branch name with git hooks without any new installation

Anibal — Wed, 29 Dec 2021 18:25:40 +0000

Introduction

Hi All !
I'm a tech lead, and I'm on charge to check Pull Request/Merge Request on my team. And also to create release notes (CHANGELOG.md) on each release.
So, my first problem was to resolve the commits of the developers, that they always have some mistake, or have errors into the commit message (without correct format), or errors in the branch name.
I searched and I found different solutions. A lot of them need to use an external software, like node (npm library), or php composer library, etc. And the projects are in different technologies, like Android, PHP, .NET, etc.

After checking all that I found, I created a solution that works in all environments without external dependencies.

The solution is really easy.
You need to follow these easy steps

Steps:

create .git-hooks folder into your project root directory, at the same level you already have .git folder
create 2 files into this folder: pre-commit and prepare-commit-msg (these two files don't have an extension)
put the correct code into each file (I will add them below these steps)
run this command in your command line, into your main folder of your project (one level up from .git-hooks): git config core.hooksPath .git-hooks
READY !

The Code

pre-commit file code:

#!/bin/bash

BRANCH=$(git rev-parse --abbrev-ref HEAD)
REGEX="^(dev|release)-([0-9]+)-q([0-9]+)\.([0-9]+)\.(.+)$"

if ! [[ $BRANCH =~ $REGEX ]]; then
  echo "Your commit was rejected due to branching name"
  echo "Please rename your branch with '(dev|release)-YYYY-qX.X.X' syntax"
  exit 1
fi

prepare-commit-msg file code:

#!/bin/bash

MESSAGE=$(cat $1) 
COMMITFORMAT="^(feat|fix|docs|style|refactor|test|chore|perf|other)(\((.*)\))?: #([0-9]+) (.*)$"

if ! [[ "$MESSAGE" =~ $COMMITFORMAT ]]; then
  echo "Your commit was rejected due to the commit message. Skipping..." 
  echo ""
  echo "Please use the following format:"
  echo "feat: #1234 feature example comment"
  echo "fix(ui): #4321 bugfix example comment"
  echo ""
  echo "More details on COMMITS.md"
  exit 1
fi

You can edit it according to your needs.

Explanation

File pre-commit: check branch names.
In my case I filter to use only format like that:
dev-YYYY-qX.X.X
release-YYYY-qX.X.X
Where YYYY is the year, and X.X.X is the version, in our case we use the Quarter number.
You could change that using regex and put what you want ;)

File prepare-commit-msg: check commit message.
In our case, we use the following format:
https://www.conventionalcommits.org/en/v1.0.0/

http://karma-runner.github.io/1.0/dev/git-commit-msg.html

Off course, you could change it as your needs.

And finally, the command git config core.hooksPath .git-hooks change your local git hooks configuration to use the new path .

My Developer Setup

Anibal — Wed, 26 Feb 2020 16:50:07 +0000

Hi all !
Finally I could upload my desktop setup and explain what things I have/use every day as Developer.
I work in company as Frontend Developer (Angular and AngularJS) , and as freelancer in my free time as fullstack (PHP, JS, etc)

Hardware:

External Display Samsung SyncMaster T260N (vga, old, but it is ok :D )
Notebook Asus TUF FX705DT
- Memory: 32 GB Ram
- Processor: AMD® Ryzen™ 7 3750H Processor
- Display: 17.3" (16:9) LED-backlit FHD (1920x1080)
- Graphic: NVIDIA® GeForce® GTX 1650 , with 4GB GDDR5 VRAM
- Storage: 512GB PCIe® Gen3 SSD
Keyboard and Mouse Logitech
Speakers 2.1 Genius

Software

The software that I use every day as developer in the mostly cases are:

GNU/Linux Operating System. Now with Ubuntu 18.04 (sometimes I hop between different distros like Mint, Kubuntu, Fedora, Elementary, Antergos, etc)
Visual Code Studio
Sublime
Slack
Audacity
Terminator
Gisto
DBeaver
Filezilla
Gimp
Libreoffice
MySql Workbench
Meld
Postman
Robo3t
Zoom
Termius
SoapUI
Docker
ZSH
Chrome

Chrome Extensions/Apps:

Workona
ClickUp
TimenEye
Bitwarden
Awesome Screenshot
AdGuard Adblocker
The Great Suspender
Deezer
Loom
AdGuard VPN
JSON Formatter
WhatRuns
Unsplash Instant

And someone else :)

My post was inspired by :
https://dev.to/starbist/my-setup-54a6

How to develop WordPress sites no matter where you are

Anibal — Tue, 08 Oct 2019 20:42:55 +0000

It is my first article, so, sorry if I make mistakes :D

Why I developed it?
To who is it?
Features
Free vs Subscription
Backlog

Why I developed it?

I am a developer, but sometimes I use different online services.
For example to develop WordPress sites I was used different online platforms.

Why I used it ? Because I want to develop from my computer or from my work laptop, or whatever I am, without having a local environment and the data into my computer. And also, to pass url to my client without having my computer sharing connection and without using my hostings.

Why I created DemosWP?
Because some online services went 100% paid services. And I want to have and offer at minimun 1 site free to could develop and test online.
So, after some different steps and stages, I create and put online this platform.

To who is this?

This platform is ideal for:

people who are learning
people who want to try something quickly online without having to install anything
people who work from different places or computers
teachers who want to give their students a place to learn without having to have knowledge of installing a local environment or acquiring a hosting
people who work as a team and want to have a place in common to work at the same time

Features

Features that the platform has at this moment:

Create sites with a few clicks
Install plugins and themes with the same site creation form
Import dummy content to have site with fake content and doesn't have it empty (WooCommerce dummy products too)
FTP and MySQL access
etc

Free vs Subscription

At the beggining the platform was 100% free. But I have a big problem that another services doesn't have. More user require more and more resources (servers disk size, cpu, memory, etc).
And only with sponsors I couldn't cover these expenses, so, I need to add paid subscriptions and limit free accounts (sites amount and features enabled).

Backlog

I want to add more features in the close future.
Like this:

clone site with few click
import sites backups with a few clicks
migrate site to hosting (using mysql and ftp connection)
add ssl to all sites
create blueprints and create new sites using that
create new sites based on complete templates ready to use
and more

You could use it here:
https://demoswp.dev

Thanks !