Git 101

From Beam Line Controls
Revision as of 17:14, 21 November 2023 by Rodolakis (talk | contribs)
Jump to navigation Jump to search

Git Workflow Components


Git 101.jpg


  • Working Directory: Your local workspace where you edit files. Changes here are not tracked until moved to the staging area.
  • Staging Area: A prep zone for changes to be committed. You can selectively choose which changes to include in a commit.
  • HEAD: The latest commit in the current branch, acting as a pointer to your most recent work.
  • Local Repository: Your computer's storage for all your commits, branches, and the entire change history. It operates independently of network access.
  • Remote Repository: A server-hosted repository (e.g., GitLab, GitHub) for code sharing and backup. It syncs with the local repository through push and pull commands.

Git File Status

Tracked vs Untracked Files

  • Tracked files are those that Git knows about and has in its version history.
  • Untracked files are new or unrecorded files in your working directory that Git isn't keeping track of yet; e.g. temp/, auto_settings.sav*, auto_positions.sav*, etc.

Staged vs Unstaged

  • Staged files are those that have been marked for inclusion in the next commit, showing Git exactly what changes you want to commit.
  • Unstaged files are the modified files in your working directory that have not been marked for the next commit yet.


Basic Commands Cheat Sheet

Syncing with Remote Repository

  • To update your local repository to match the remote repository, use:

$ git fetch # fetches updates made in the remote repository

  • To apply changes fetched from the remote repository to your working directory:

$ git pull # fetches and merges changes from the remote repository to your current branch

  • To push local commits to the remote repository:

$ git push # pushes your commits to the remote repository

  • To view the remote repository information:

$ git remote -v # lists the remote repositories and their URLs




Committing Changes

  • To commit a single tracked file:
$ git add <file>   # add file to staging area
$ git commit -m 'commit message'  # commit file changes
  • To commit all tracked files at once, use option -a>:
$ git commit -am 'commit message'  # add all tracked files to staging area & commit them


Viewing Changes and Status

  • To view differences since the last commit:
$ git diff <file>
  • To see tracked files:
$ git ls-files


Syncing with Remote Repository

  • To push local commits to the remote repository:
$ git push



Basic Workflow Example

To add new files: $ git add <newfile>

To modify files: $ git add <modifiedfile>

To commit changes: $ git commit -m 'Description of changes'

To push to the remote repository: $ git push origin <branch>


Ignoring Files

.gitignore lists files and folders to be ignored. To update the list, just use any file editor.