Git

We Want to Keep the Files Locally Modified but Unstaged

  • If you want to keep local changes without staging them for commits:
git update-index --assume-unchanged config1.yml
git update-index --assume-unchanged config2.yml
git update-index --assume-unchanged config3.yml
  • These files will not appear in git status anymore.
  • They will remain untracked in future commits but still exist locally. To revert this and track them again:
git update-index --no-assume-unchanged config1.yml
git update-index --no-assume-unchanged config2.yml
git update-index --no-assume-unchanged config3.yml
  • list files in –assume-unchanged
git config --global alias.hidden '!git ls-files -v | grep "^[a-z]"'

We Never Want to Accidentally Modify These Files

  • If these files are in the repository but should never be changed on your local machine, use:
git update-index --skip-worktree config1.yml
git update-index --skip-worktree config2.yml
git update-index --skip-worktree config3.yml
  • This tells Git to ignore future changes in these files unless you explicitly change them. To undo this and allow modifications again:
git update-index --no-skip-worktree config1.yml
git update-index --no-skip-worktree config2.yml
git update-index --no-skip-worktree config3.yml

git.config 

$ cat .gitconfig
[alias]
        lg = log --oneline --graph --decorate --all
        lgt = log --pretty=format:'%h %an %ar %ad %s' --date=iso --all --graph
        hidden = !git ls-files -v | grep \"^[a-z]\"

branch operations 

# set the remote branch to track the local branch
git push --set-upstream origin branchb

# check upstream branch
git branch -vv

# change upstream branch later
git branch -u origin/branch-name

# delete a branch
git branch -d <branch-name>

# create a new branch
git checkout -b <branch-name>
git switch -c <branch-name>

# rename branch
git branch -m <new name>

tag is a snapshot of all the commits at that time 

# create a tag, -a means annotation, 
git tag -a v1.0.0 -m "version 1.0.0"
git tag
git push origin v1.0.0

# pull latest code and tag again
git pull
git tag
git tag -a v1.0.1 -m "version 1.0.1"
git tag
git push origin v1.0.1

merge, on development branch, do operations to merge feature branch into development branch 

# merge feature branch into development branch, locally
git checkout development
git merge feature-branch

# merge development branch into feature branch, without tracking development locally
git checkout feature-branch
git fetch origin
git merge origin/development

# conflict content will show message like:
# CONFLICT (content): Merge conflict in some-file.js

# resolve conflict, stage, commit, and then push
# git commit -m "Resolved merge conflicts between development and feature-branch"

rebase 

git checkout feature-branch
git pull --rebase origin development

# If conflicts occur, resolve them and continue rebasing:
git rebase --continue

# After rebasing, force push since history is rewritten:
git push --force origin feature-branch

git diff 

git diff remote-origin/branch-name # compare local with remote

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Create a Revert Commit by Resetting and Commiting 

# 1. Start a new branch from latest main
git checkout main
git pull origin main
git checkout -b fix/revert-main-to-<old-commit>

# 2. Reset working directory to old commit (but keep as changes to commit)
git reset --hard <old-commit>
git reset --soft HEAD@{1} # makes the changes from the old commit a staged change

# 3. Cmomit the changes as a new revert commit
git commit -m "fix: revert main to <old-commit-id>"

# 4. push branch
git push origin fix/revert-main-to-<old-commit>

Revert individual commits 

git checkout -b fix/revert-bad-change
git revert <bad-commit-id>
git push origin fix/revert-bad-change

Example 

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense. e.g. add, update, resolve, remove, reformat, optimize, reduce, fix, upgrade, merge, etc.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

Types

  • chore: (indicates a task that is not user facing or feature-related)
    • update dependencies
    • rename file or folders
    • update configurations
    • update pipelines
    • update docs
  • deprecated: (indicates a feature is deprecated)
  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • release: (indicates a release)

other types

  • docs: (doc change)
  • style: (code formatting)
  • refactor: (restructure or improve code, no feature change)
  • test: (add or update tests)

References:

.gitattributes 

###############################################################################
# Global text handling
###############################################################################
# Automatically normalize line endings on commit and checkout
* text=auto

# Explicitly enforce LF for source code (avoid CRLF issues)
*.java     text eol=lf
*.kt       text eol=lf
*.xml      text eol=lf
*.yml      text eol=lf
*.yaml     text eol=lf
*.sql      text eol=lf
*.sh       text eol=lf
*.ts       text eol=lf
*.js       text eol=lf
*.json     text eol=lf
*.html     text eol=lf
*.scss     text eol=lf
*.css      text eol=lf
*.md       text eol=lf

# Windows batch scripts should keep CRLF
*.bat      text eol=crlf
*.cmd      text eol=crlf


###############################################################################
# Binary files
###############################################################################
# Mark images, fonts, and archives as binary so Git won’t try to diff or merge them
*.png      binary
*.jpg      binary
*.jpeg     binary
*.gif      binary
*.ico      binary
*.zip      binary
*.jar      binary
*.war      binary
*.pdf      binary
*.eot      binary
*.ttf      binary
*.woff     binary
*.woff2    binary


###############################################################################
# Merge strategies
###############################################################################
# Never try to merge lock or dependency files automatically
package-lock.json merge=ours
yarn.lock         merge=ours
pnpm-lock.yaml    merge=ours
*.iml             merge=ours
*.class           merge=ours

# Ignore changes in generated build artifacts
/dist/*           merge=ours
/build/*          merge=ours
/target/*         merge=ours


###############################################################################
# Diff settings
###############################################################################
# Use syntax-aware diffs for specific file types
*.java diff=java
*.xml  diff=xml
*.html diff=html
*.ts   diff=javascript
*.scss diff=css
*.css  diff=css
*.md   diff=markdown

# Disable diffs for binary files
*.png -diff
*.jpg -diff
*.gif -diff
*.jar -diff
*.zip -diff


###############################################################################
# Git LFS (optional)
###############################################################################
# If using Git LFS for large media or artifacts, mark them lockable
# *.psd filter=lfs diff=lfs merge=lfs -text lockable
# *.mp4 filter=lfs diff=lfs merge=lfs -text lockable


###############################################################################
# Export / Archive rules
###############################################################################
# Exclude node_modules and build outputs when creating a Git archive
node_modules/ export-ignore
dist/         export-ignore
build/        export-ignore
target/       export-ignore
.idea/        export-ignore
.vscode/      export-ignore