blue-ice/git-workflow.md

## git-workflow.md

      
    Raw
  

              git-workflow.md
            
          
    Downloading a remote repository for the first time


cd ~/Documents/git-repositories/
We need to grab the entire repository, selecting the branch needed and the local location that should be used (HTTPS):
git clone -b <branch-name> https://github.com/blue-ice/<repo-name>.git ~/Documents/git-repositories/<repo-name>
YOU MUST cd <repo-name>

Modifications, commits and updates

First steps


cd ~/Documents/git-repositories/<repo-name>
Does git remote -v match the fetch and push links that should be in use?

If not, then git remote set-url origin git@github.com:blue-ice/<repo-name>.git


Does git rev-parse --abbrev-ref HEAD match the branch name that should be in use?

If not, then git checkout <branch-name>


Now match everything up with git pull

Push local edits


git add -A
git commit -m "<commit-message>"
git push

Undo local adding of files


git reset

Undo last commit before pushing


git reset --soft 'HEAD^'
Re-add files
Re-commit files
git push

Remove last pushed commit


Do not change branches from the one that made the bad commit.
git reset HEAD^ --hard
git push origin -f

Rename last commit message


git commit --amend
git push --force

Check to see if local repo is up to date


git fetch --dry-run

Update local repository (with no commits to push)


git pull

Revert/undelete a file from a previous commit


git checkout <commit-hash> <file-path>

Restore branch to remote state


Checkout the branch that needs to be reset.
git fetch origin
git reset --hard origin/<branch-name>

Renaming a repository


Change repo name on GitHub
Change local repo folder name: mv ~/Documents/git-repositories/<old-repo-name> ~/Documents/git-repositories/<new-repo-name>
Change local pull and push destination git remote set-url origin git@github.com:blue-ice/<new-repo-name>.git
Check to see if the output of git remote -v is the correct address.

Authentication

Set up a repo to use SSH-based authentication

NOTE: Does not work behind firewall.

git remote set-url origin git@github.com:blue-ice/repo-name.git

Set up a repo to use HTTPS-based authentication


git remote set-url origin https://github.com/blue-ice/repo-name.git
(git config --global credential.helper cache)

Increase HTTPS-based credential storage time


This will change the time that Git waits to ask you again for your username and password.
git config credential.helper 'cache --timeout=<time-in-seconds-to-keep-credentials>'

Branching

Create a new branch from current staged files (no commit) and checkout new branch


git checkout -b <new-branch-name>
git add ...
git push --set-upstream origin <new-branch-name>

Renaming a branch


Ensure that the branch to be renamed is not the "default" branch (see repo settings on GitHub). If the branch to be renamed is the "default" branch, then just switch the default branch temporarily.
Check out of the branch to be renamed locally.
Locally, run git branch -m <old-branch-name> <new-branch-name>
git push origin :<old-branch-name>
git push origin <new-branch-name>

Merge a branch with another branch


git checkout <into-branch>
git merge <from-branch> --no-ff
git push

Delete a branch


Check out of branch and make sure it is not the default (found in github repo settings)
git branch -D <branch-name> (local deletion)
git push origin --delete <branch-name> (remote deletion)

Viewing data

View latest commits (all branches)


git log --pretty=oneline

View edits before they are committed


(git add ...)
git diff --cached
(git commit ...)

View current branch in a list of all branches


git branch --list
The current branch will be marked with an asterisk and/or marked in green.

Tagging

Show tags


git tag

Show tags that match a certain pattern


Note: asterisks can be used as wildcards.
git tag -l '<tag-name>'

Add an annotated tag


see http://git-scm.com/book/en/Git-Basics-Tagging for now

Working with .gitignore files

After .gitignore update, get rid of newly ignored files


Commit and push all untracked changes.
Remove everything: git rm -r --cached .
Now add everything again (.gitignore is in effect): git add -A .
git commit ... (Sample message: ".gitignored files removed from repo.")

Create a repository .gitignore that overrides all global .gitignore requests


Create a file named .gitignore inside the root repository folder.
Put the rule !* inside the file.

Forking and pulling

Forking a repo

see Forking a Repo

Click the "Fork" button online on the project to you want to fork.
cd ~/Documents/git-repositories/
We need to grab the entire repository, selecting the branch needed and the local location that should be used: git clone -b <branch-name> https://github.com/blue-ice/<repo-name>.git ~/Documents/git-repositories/<repo-name>
cd <repo-name>
Add a new upstream: git remote add upstream https://github.com/<forked-user>/<forked-repo-name>.git
git push -u origin master

Push to a forked repo (personal)


git add ...
```git commit ...````
git push -u origin master

Fetch changes from upstream


Make sure that an upstream is set up.
git fetch upstream
git merge upstream/master
git push

Send a pull request

NOTE: The fork of a repo can be deleted once the pull request has been approved.
see https://help.github.com/articles/using-pull-requests
Change personal branch name, but still be able to pull request to the original repo


Click the "Fork" button online on the project to you want to fork.
Go to https://github.com/blue-ice/<cloned-repo-name>/settings and rename the repo.
We need to grab the entire repository, selecting the branch needed and the local location that should be used: git clone -b <branch-name> git@github.com:blue-ice/<renamed-repo-name>.git ~/Documents/git-repositories/<renamed-repo-name>
cd <repo-name>
Add a new upstream: git remote add upstream https://github.com/<forked-user>/<forked-repo-name>.git
git push -u origin master

Merging

Stop a merge

1. This is for use when there is a merge conflict and you want to restore the repository to the unmerged state.
2. ```git reset --merge```
Modify a file and use it in a merge conflict


Edit the file.
git add <file-name>

Use "their" version of the file in a merge conflict


git checkout --theirs README.md
git add README.md

Use "our" version of the file in a merge conflict


git checkout --ours README.md
git add README.md

Add a repository into another repository (keep the old commits)


git clone <into-repo>


git clone <from-repo>


cd <into-repo>


git checkout <into-repo-branch>


git remote add temp-remote ../<from-repo>


git fetch temp-remote


git branch temp-branch temp-remote/<from-repo-clone-branch>


git checkout temp-branch


mkdir <from-repo>


rsync --remove-source-files -av ./ ./<from-repo> --exclude .git


git add -A


git commit -m "Reorganized files from other repository."


git clean -fd


git checkout <into-repo-branch>


git merge temp-branch


git push


git branch -D temp-branch


git remote rm temp-remote


Troubleshooting

Nonexistent branches


If git branch -a shows nonexistent branches...
It most likely needs a git fetch -p to fetch and prune the repository
If that doesn't work, the bad branch has a local copy and/or a remote copy that both need to be deleted (check out of the branch first):

Local deletion: git branch -D <branch-name>
Remote deletion:git push origin --delete <branch-name>


Commits are not showing up on user page or in commit graph


The <master> (or "default") branch is the basis for user profile updates. See here for information on merging to correct the issue.