git/README.md

   1 ---
   2 title: Git
   3 homepage: https://git-scm.com
   4 tagline: |
   5   git: --fast-version-control
   6 description: |
   7   > Git is a fast, scalable, distributed revision control system with an
   8   > unusually rich command set that provides both high-level operations and full
   9   > access to internals.
  10 ---
  11
  12 Github's [Git 'Hello World'](https://guides.github.com/activities/hello-world/)
  13 is a good place to get started if you're new to git.
  14
  15 ### How to commit files
  16
  17 ```bash
  18 git add ./path/to/file1
  19 git add ./path/to/file2
  20 git commit -m "my summary for this commit"
  21 ```
  22
  23 ### How to ignore common files
  24
  25 In your project repository create a `.gitignore` file with patterns of fies to
  26 ignore
  27
  28 ```txt
  29 .env*
  30 *.bak
  31 *.tmp
  32 .*.sw*
  33 ```
  34
  35 ### How to create a branch
  36
  37 This will branch from the branch you're currently on.
  38
  39 ```bash
  40 git checkout -b my-branch-name
  41 ```
  42
  43 ### How to rebase
  44
  45 Rebase when fetching new updates
  46
  47 ```bash
  48 git pull --rebase origin master
  49 ```
  50
  51 Rebase a feature branch from master before a merge
  52
  53 ```bash
  54 # update master
  55 git fetch
  56 git checkout master
  57 git pull
  58
  59 # go back to your feature branch
  60 git checkout my-feature
  61
  62 # start the rebase
  63 git rebase master
  64
  65 # fix conflicts if you need to, and then continue
  66 git add ./my-merged-file
  67 git rebase --continue
  68 ```
  69
  70 ### How to authenticate git with deploy tokens
  71
  72 Abbreviated from
  73 [The Vanilla DevOps Git Credentials & Private Packages Cheatsheet](https://coolaj86.com/articles/vanilla-devops-git-credentials-cheatsheet/):
  74
  75 First, update `.gitconfig` to handle each type of git URL (git, ssh, and http)
  76 as https:
  77
  78 ```bash
  79 git config --global url."https://api@github.com/".insteadOf "https://github.com/"
  80 git config --global url."https://ssh@github.com/".insteadOf "ssh://git@github.com/"
  81 git config --global url."https://git@github.com/".insteadOf "git@github.com:"
  82 ```
  83
  84 Next, create a `.git-askpass`:
  85
  86 ```bash
  87 echo 'echo $MY_GIT_TOKEN' > $HOME/.git-askpass
  88 chmod +x $HOME/.git-askpass
  89 ```
  90
  91 Finally, add the following ENVs to your deployment environment:
  92
  93 ```bash
  94 GIT_ASKPASS=$HOME/.git-askpass
  95
  96 # Relpace xxxx... with your deploy token
  97 MY_GIT_TOKEN=xxxxxxxxxxxxxxxx
  98 ```
  99
 100 In the case of Github it may be useful to create a read-only deploy user for
 101 your organization.
 102
 103 This can work with Docker, Github, Gitlab, Gitea, CircleCI, and many more.