Git on Codrut Constantin Gusoi

Git init without branch hint

Sat, 14 Jan 2023 13:16:34 +0000

If you run git init you will get this yellow hint:

hint: Using 'master' as the name for the initial branch. This default branch name
hint: is subject to change. To configure the initial branch name to use in all
hint: of your new repositories, which will suppress this warning, call:
hint:
hint:   git config --global init.defaultBranch <name>
hint:
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint:
hint:   git branch -m <name>

This is annoying, pointless, and a complete waste of the git core developer’s time as well as ours.

Git root empty commit

Sun, 08 Jan 2023 13:15:48 +0000

The best way to structure yout repository is to have an empty root commit and to squash all the other commits periodically onto the second. This reduces the repository size making it easier to clone in CI and for your end users.

Empty root commit Link to heading

Create an empty commit:

git commit -m 'Initial commit' --allow-empty

Rebase until your root commit:

git rebase -i --root

Move the last commit at the very top of your commit list.

Test for Emacs compiler warnings

Sat, 10 Sep 2022 10:55:37 +0000

Setup Link to heading

Your .gitignore:

*.elc

A Makefile containing:

.PHONY: compile
compile:
	@emacs -q -batch \
	  --eval '(setq byte-compile-error-on-warn t)' \
	  -f batch-byte-compile \
	  *.el

The first indentation is a tab, the following two are spaces. Makefiles just work this way for reasons beyond human comprehension.

Run Link to heading

Executing make compile will compile all your .el files and error in case there are any warnings.

Git refined diff output

Fri, 09 Sep 2022 07:29:17 +0000

Package Link to heading

Find the location of your diff-highlight package:

Manjaro/Arch

pacman -Ql git | grep diff-highlight

Debian/Ubuntu

dpkg -L git | grep diff-highlight

Fedora

rpm -ql git | grep diff-highlight

Configure Link to heading

Edit your ~/.gitconfig to contain this section:

Check for Git differences in CI

Tue, 03 May 2022 07:49:16 +0000

The command is:

git diff --exit-code

Prints the diff and exits with status code 1.

CI Link to heading

generate:
  image: ruby:3.1.2-alpine
  script:
    - apk add --update git make
    - make generate
    - git diff --exit-code

The most terrifying Git command

Sun, 29 Nov 2020 16:52:21 +0000

git clean -fdx

It removes all files not tracked or staged by git. Useful for cleanup and reverting your project to “factory settings”.

But you might want to keep some directories around, like editor specific caches. You can do this:

First, add the directory you want to keep in .gitignore; it has to be the entire directory, with none of it’s contents tracked:

# Good

/.idea/
/env/
/secrets/

# Bad (Don't do this!)

/secrets/*
!/secrets/.keep

Now you need to do a git init in each of those directories. Add a shiled goal to your Makefile:

.PHONY: shield
shield:
	@git init .idea
	@git init env
	@git init secrets

Make sure to execute make shield after cloning the repository!

How to configure Git properly

Wed, 01 Jul 2020 19:16:38 +0000

Required Link to heading

You need a name and email otherwise commits won’t work:

git config --global user.name 'Your Name'
git config --global user.email 'your.email@faang.com'

Global .gitignore Link to heading

Don’t put junk like these in your poject’s .gitignore:

.DS_Store
.idea/
*.swp

Use your own config:

touch ~/.gitignore
git config --global core.excludesfile '~/.gitignore'

Symlink .dockerignore Link to heading

Add the git directory to your .gitignore file:

How to Use: editorconfig

Thu, 11 Jun 2020 19:15:32 +0000

This is editorconfig:

https://editorconfig.org

This is the checker:

https://github.com/editorconfig-checker/editorconfig-checker

Install Link to heading

The CLI tool:

# Manjaro / Arch
sudo pacman -S git editorconfig-checker

# Alpine
apk add --update git editorconfig-checker

Check your text editor’s plugins for editorconfig integration. Spacemacs has it already built in.

Usage Link to heading

Add an .editorconfig file to your project root:

root = true

[*]
charset                  = utf-8
end_of_line              = lf
indent_style             = space
insert_final_newline     = true
tab_width                = 2
trim_trailing_whitespace = true

[Makefile]
indent_style = tab

[{tmp/**/*,cache/**/*}]
charset                  = unset
end_of_line              = unset
indent_style             = unset
insert_final_newline     = unset
tab_width                = unset
trim_trailing_whitespace = unset

Now you can lint your repository: