Git - Tag - Dimas Maulana

Best Practices for Git Branch Naming Convention

Thu, 08 Jun 2023 17:06:00 +0700

In the world of software development, Git has become the go-to version control system for managing projects effectively. One aspect that greatly contributes to a streamlined development process is adopting a consistent and meaningful branch naming convention. In this article, we will delve into the best practices for Git branch naming, empowering teams to organize their work and collaborate efficiently.

Branch Type	Branch Name Examples
`develop`	`develop`
`main`	`main`
`feature`	`feature/user-authentication`
	`feature/shopping-cart`
	`feature/payment-integration`
`bugfix`	`bugfix/fix-login-issue`
	`bugfix/1234`
	`bugfix/calculate-total-error`
`release`	`release/1.0.0`
	`release/alpha`
	`release/beta`
`hotfix`	`hotfix/critical-bug`
	`hotfix/4321`
	`hotfix/typo-correction`

1. Develop a `develop` Branch

To foster ongoing development work, establish a dedicated branch named develop. This branch serves as the main staging area for integrating and testing new features before they are ready for production. By using this common convention, developers can easily identify where ongoing development work takes place.

Naming Conventions for Production Environments

Tue, 06 Jun 2023 06:47:00 +0700

Naming conventions are a crucial aspect of software development, providing consistency and clarity in various stages of the development lifecycle. In this article, we will explore the most common naming conventions for production environments, focusing on GitLab CI/CD, GitHub Actions, domain names, branch names, Docker Compose files, and Dockerfile names.

Naming	Common Convention
GitLab CI/CD Convention	prod
GitHub Actions Convention	prod
Domain Names	example.com
Branch Names	main/master
Docker Compose Files	docker-compose.yml
Dockerfile Names	Dockerfile

GitLab CI/CD Convention

In GitLab CI/CD, the convention for naming pipeline stages in production environments commonly involves using “prod” as the keyword. This convention ensures that pipeline stages are easily identifiable and aligned with the production deployment process.

Naming Conventions for Development Environments

Tue, 06 Jun 2023 06:45:00 +0700

Naming conventions play a vital role in software development environments, providing consistency and clarity throughout the development process. In this article, we will explore the most common naming conventions for development environments, covering GitLab CI/CD, GitHub Actions, domain names, branch names, Docker Compose files, and Dockerfile names.

Naming	Common Convention
GitLab CI/CD Convention	dev
GitHub Actions Convention	dev
Domain Names	dev.example.com
Branch Names	dev
Docker Compose Files	docker-compose.dev.yml
Dockerfile Names	Dockerfile.dev

GitLab CI/CD Convention

When working with GitLab CI/CD, the most common convention for naming pipeline stages in development environments is to use “dev” as the keyword. This convention ensures compatibility and alignment with GitLab CI/CD’s pipeline system.

Naming Conventions Stage vs Staging in Software Development

Tue, 06 Jun 2023 06:24:00 +0700

Naming conventions play a crucial role in software development, providing clarity and consistency in various aspects of the development lifecycle. When it comes to naming environments, such as staging, development, and production, there can be variations and debates around the usage of “stage” and “staging.” In this article, we’ll explore the differences and common practices surrounding these terms.

Defining Staging and Development Environments

Naming	Common Convention
GitLab CI/CD Convention	stage
GitHub Actions Convention	staging
Domain Names	staging.example.com
Branch Names	staging
Docker Compose Files	docker-compose.staging.yml
Dockerfile Names	Dockerfile.staging

Staging environments are integral to the software development process, serving as a dedicated space for testing and validation before deploying to production. In most cases, “staging” is commonly used as a noun to represent this environment. It refers to a stable and controlled testing area where developers can ensure their applications are functioning correctly and meet the required standards.

Clone Multiple Github Repositories With Different Deployment Keys But The Same Username

Fri, 05 May 2023 08:20:00 +0700

Cloning multiple GitHub repositories with different deployment keys can be useful when you need to access multiple repositories using different SSH keys associated with the same GitHub account. This guide provides step-by-step instructions on how to clone multiple repositories with different deployment keys while using the same username. By following these steps, you can streamline your workflow and manage multiple repositories more efficiently.

Step 1: Generate Deployment Keys

To begin, generate a deployment key for each repository you want to clone. Use the ssh-keygen command on your local machine to create a unique key for each repository.

Fixing Git Commit Not Replacing Folder with Changed Case on Mac

Wed, 19 Apr 2023 08:27:26 +0700

If you’re working on a Mac and using Git, you might run into an issue where Git won’t replace a folder that has had a change in case. For example, if you have a folder called “Article” and you change it to “article”, Git might not recognize the change and won’t replace the old folder with the new one.

Fortunately, there is a solution to this problem. You can configure Git to not ignore case sensitivity by running the following command:

How to Rename Author on All Commits in Git

Fri, 22 Apr 2022 05:36:06 +0700

In Git, there may be situations where you need to update or correct author information on all commits, such as changing email addresses or fixing incorrect names. This guide will explain how to rename authors on all commits using the git-filter-repo tool.

Requirements

git-filter-repo: You can install it from the official repository at https://github.com/newren/git-filter-repo.

Procedure

Step 1: Create a .mailmap File

Create a file named .mailmap in the root directory of your Git repository. This file will map the old author information to the new author information. The correct format for each entry is as follows:

GIT Commit Message Naming

Fri, 01 Apr 2022 04:51:17 +0700

Introduction

A well-structured commit message is crucial for maintaining a clean and readable project history. The Conventional Commits specification provides a standard format for commit messages, making it easier to generate changelogs, automate versioning, and improve collaboration. This document outlines the naming conventions and structure for Git commit messages.

Git Gitlab Flow

Mon, 28 Mar 2022 06:17:30 +0700

GitLab Flow is a set of best practices for using Git with GitLab, combining elements of Git Flow and GitHub Flow to support various workflows. It emphasizes the use of feature branches for development, with integration to GitLab’s CI/CD pipeline for continuous testing and deployment.

Production Branch

flowchart TB
a-->b-->c-->d-->e
f-->g
c--deployment-->g
g-->h
a[development]
b[development]
c[development]
d[development]
e[development]
f[production]
g[production]
h[production]

Environtment Branches

flowchart LR
a-->b-->c-->d
e-->f-->g-->h
i-->j-->k
a--deploy to\npre-prod-->e
c--deploy to\npre-prod-->g
e--production\ndeployment-->j
a[staging]
b[staging]
c[staging]
d[staging]
e[pre-prod]
f[pre-prod]
g[pre-prod]
h[pre-prod]
i[production]
j[production]
k[production]

Release Branches

flowchart LR
a-->b-->c-->d-->e
a-->f-->g
c-.-chery-pick-.->g
d-->i
a[main]
b[main]
c[main]
d[main]
e[main]
f[2.3-stable]
g[2.3-stable]
i[2.4-stable]

Git Repository Naming

Thu, 17 Feb 2022 05:48:49 +0700

This article explores best practices for naming Git repositories, ensuring clarity, consistency, and maintainability. It covers key considerations such as readability, versioning, project scope, and collaboration standards to help developers create effective repository names.

Microservices

Better suited to a project team or department where multiple products exist and are made up of sub-components.

Merging Git Without History and Resolving Conflicts Using Theirs

Thu, 29 Nov 2012 08:38:39 +0700

When merging Git branches, it is sometimes desirable to combine the changes from one branch into another without preserving the commit history of the merged branch. Additionally, conflicts may arise during the merge process that need to be resolved using the “theirs” strategy, which means accepting the changes from the branch being merged in.

Here’s a step-by-step guide on how to perform such a merge:

Step 1: Perform the Merge with Squash

To merge the changes from one branch into another without preserving the commit history, you can use the --squash option with the git merge command. The --squash option condenses all the commits from the merged branch into a single commit in the target branch.

Git - Tag - Dimas Maulana

Best Practices for Git Branch Naming Convention

1. Develop a develop Branch

Naming Conventions for Production Environments

GitLab CI/CD Convention

Naming Conventions for Development Environments

GitLab CI/CD Convention

Naming Conventions Stage vs Staging in Software Development

Defining Staging and Development Environments

Clone Multiple Github Repositories With Different Deployment Keys But The Same Username

Step 1: Generate Deployment Keys

Fixing Git Commit Not Replacing Folder with Changed Case on Mac

How to Rename Author on All Commits in Git

Requirements

Procedure

Step 1: Create a .mailmap File

GIT Commit Message Naming

Introduction

Git Gitlab Flow

Production Branch

Environtment Branches

Release Branches

Git Repository Naming

Microservices

Merging Git Without History and Resolving Conflicts Using Theirs

Step 1: Perform the Merge with Squash

1. Develop a `develop` Branch