Troubleshooting

STEP 1 IS ALWAYS KEEP CALM. Tea is highly recommended.

Untagged commit

I pushed a commit onto develop, but I meant to make a hotfix / I forgot to make a hotfix before pushing

If you don't want to revert your last commit(s) but keep them: You can either keep working on develop since you're likely working on dev55 as it is, which should be on develop branch, and then do a git release when you are ready to put your changes live. The process to follow is thus:

git stash
git checkout master
git pull --rebase
git checkout develop
git flow release start 1.2.3
git stash pop
(grunt)
git add .
git commit -m "Merging develop changes into master"
git flow release finish 1.2.3
git push --all
git push --tags

Premature commit

I prematurely made a commit / I made a commit I didn't mean to / I made a commit and it destroyed the whole site

revert your last commit(s)

Local changes

Everything is messy on local / how can I clean local / how can I just get it locally how it is on the repo?

Local changes can be undone with:

git checkout -- <bad filename>

This WILL erase any change you've made.

Wrong branch commit

Scenario: You made some commits, then realized you were checked out on master. You wish you could make those commits on a feature branch instead.

 
git branch feature
git reset --hard origin/master
git checkout feature

Setup

Git home config file

~/.gitconfig

[user]
    name = (your name)
    email = (your email)
[color]
    diff = always
    ui = true
[core]
    excludesfile = /home/(your user)/.gitignore_global
    autocrlf = input
    sharedRepository = 0664
[alias]
    ci = commit
    co = checkout
    br = branch
    st = status
    graph = log --pretty=format:\"%h %s\" --graph
[push]
    default = simple
[branch]
    autosetuprebase = always

Git Ignore File

create a file called .gitignore_global in you home directory
git config --global core.excludesfile ~/.gitignore_global

# OS generated files #
######################
.DS_Store*
ehthumbs.db
Icon?
Thumbs.db
._* 
*.swp 

# Gaslight Media Application specific #
# files that are updated on server    #
#######################################
admin/logs/
GLM_site_check.phtml
iconCache/
uploads/
cache/
compiled/
compile/
original/
resized/
midsized/
thumb/
thumbs/
ht_images/
photo-large/
photo-small/
prototype/
weather-feed.xml
php.error
reports/
editimagesworkwith/
editimagesoriginal/
editedImages/
editimagespng/
.buildpath
.settings
.project
.svn
nbproject/
smarty/

Procedure

Git New Website Setup Checklist

git init
git flow init: all defaults except the version tag prefix, which is v
git status
git add .
git commit -m "Initial Commit" 
OR git commit, so you can check files, then "Initial Commit"
git remote add origin git@cvs2.gaslightmedia.com:WP-Themes/YourRepo
git push --set-upstream origin master // git push -u origin master:master might work
git push --set-upstream origin develop // git push -u origin develop:develop might work

Git Flow

Master branch

For production code only

Develop Branch

For new features or revamps.

Release Branch

Used for creating new releases of code from the develop branch (merges back into master and develop)

git flow release start v1.0 (then do your work and commit)
git flow release finish v1.0

Hotfix Branch

Use a hotfix for doing any small site updates and maintenance like graphic changes or text changes. These changes are typically not considered

git flow hotfix start v1.0.1 (then do your work and commit)
git flow hotfix finish v1.0.1

NOTICE: it is wise to do a git pull first before you start with a release or hotfix

Support Branch

These branches are just started and not intended to be merged back to master nor develop. This is usually fine, as fixes to "ancient" releases or features requested by customers to be implemented in "ancient" releases can't or should not go back into master. If you still think, you want to port a fix to your main development line (represented by master and develop), just start a hotfix, cherry-pick your changes and finish the hotfix.

== Set up local branches as tracking branches

$ git branch --set-upstream master origin/master
$ git branch --set-upstream develop origin/develop

Process

NOTICE: If others have been working on the project and have made a release or hotfixes before you you'll need to update all your branches. (usually your on only develop and only that is the one you are updating)

$ git pull --all

When you're done with either a hotfix or release you need to push all branches and tags

git push --all
git push --tags

Example

The following merely an example. Things may not always follow this line of commands exactly. See also: Cheat Sheet 1, Cheat Sheet 2, or Cheat Sheet 3

(0. ssh-add)

This is optional, to avoid having to enter your password every time you SSH into a remote server. Have a look at Setting up ssh to not need a password if you care for such convenience.

1. git clone p1 p2.

This is similar to svn checkout. You take the repository from the first parameter, and put it into the second. e.g.: git clone git@cvs2:web/mywebsite.git www.mywebsite.com. If you just want to update, and aren't making your first changes to a project, do git pull origin develop instead.[first do git flow init]

2. cd www.mywebsite.com

Go into the website's directory so that you can use git commands in the future.

3. git flow init

You will be asked things. Just hit enter for master, develop, feature, release, hotfix and support, and on the final one type the letter V - this should only be necessary -once- the very first time anyone sets up the repository for the website.

4. git branch -av

This shows what branch you are on, as well as the branches that exist both locally and remotely. I think -av means show me All branches, and be Verbose.

5. git checkout develop

Unlike SVN, this command merely changes the branch you're currently on to Develop

6. git flow hotfix start 1.0.3

This creates the hotfix branch called 1.0.3. Another example is git flow feature start AwesomeFeature. You will automatically be put into that branch, so that you will work from it.

-- start up your favorite editor and make whatever changes to whichever project/files you please --

7. git status

This will show you all files that have been changed, and whether they are pending committing or adding.

8. git add .

Be mindful of the period. This will make all files in all folders under the current directory ready for committing. To add a single file, for example: git add .htaccess.

9. git commit

This will commit changes to the main branch. If you did this and forgot to change/add a certain file, simply do git commit --amend when you're ready.

10. make liberal use of git status.

This will also show the command git reset HEAD <file> to remove something you git add-ed in error (the command also works on folders). e.g. git reset HEAD .htaccess

11. git flow hotfix finish '1.0.3'

(this will bring you back to the develop branch and delete the hotfix branch after it merges its changes. Make note of your edits!)

(*. git flow feature publish someFeature is another example, though publish doesn't remove the branch, it merely merges your changes with the main branch)

(*. Git may at some point complain about the fact that there are changes to wherever you're trying to commit/push to. It's merely a matter of doing git pull origin develop (where origin is the name of the branch you're taking it from, and develop is the branch you're taking it to) so that you're up-to-date!)

(*. git pull is really two commands combined into one: git fetch takes it from the main repository onto your remotes branch, then git merge takes it from remotes to whatever branch you indicated such as Develop or feature/someFeature

(*. This is also when you may realize you didn't yet start a branch, and you've already made changes. Have a look at git stash, which will essentially put all changes into a separate stash. Then git flow feature start awesomeFeature, which should put you on that branch, then do git stash pop to drop the stash onto that branch, after which the branch can be finished or published as noted above)

10. git branch -av

Same command as before, to make sure what branch you're on.

11. git push origin develop

This will send the committed changes to the remote main branch - this will push it TO origin FROM develop.

12. gitk to marvel at a graphical representation of the good you've done today

13. ssh ws6 (or dev53 or whatever server), then cd /var/www/server/www.myweb~

14. git pull origin develop

This has to be done for the changes you made, added, committed and pushed to actually have effect. This command may also be used on your own server, sort of like svn checkout, instead of cloning at step 1. On WS6 you use git pull origin master instead, since it only has a master branch.

15. git pull --all

This will fetch all branches from origin and merge them with their tracking branches.

16 git branch -u origin/develop develop && git branch -u origin/master master

setup your (local) branches as tracking branches (if you did git init)

So, in summary, considering the repository has already been set up and you just want to make some changes:
git branch -av to see what branch you're on and which exist
git checkout develop to hop onto the branch called develop (this does not checkout like svn! git pull does that)
git pull origin develop to make sure your files are up to date, when you're in the website's directory. Most similar to svn checkout.
git flow feature SomeName to start a feature branch named SomeName
git flow hotfix 1.7.2 to start a hotfix branch named 1.7.2
git status to see how your local file copies differ
git add someDir/someFile to add that file or folder to the list of things to be committed.
git reset HEAD someFile> to undo a git add, taking a file off the list of things to be committed.
git commit to commit changes to the branch. git commit --amend in case of last-minute additions
git push origin develop Send the committed changes from your Develop branch to the remote Origin branch.
gitk for a gui

Common Commands

Creating a new Git repo

You need to be setup on our Version Control Server with a public key to have access to our gitolite server.

Once you have been setup you can create a repo on the server buy attempting to clone a git project that doesn't exists on gitolite server yet.

to get a list of projects already in gitolite try to ssh to our git server.

ssh git@cvs2
PTY allocation request failed on channel 0
hello steve, this is git@cvs running gitolite3 v3.5.2-10-g437b497 on git 1.7.9.5
 R W C  prog/[a-zA-Z0-9].*
 R   C  user/CREATOR/[a-zA-Z0-9].*
 R W C  web/[a-zA-Z0-9].*
 R W    gitolite-admin
 R W    prog/Smarty-3.1.14
 R W    prog/bugzilla-4.4
 R W    testing
 R      user/leif/newproject
 R W    user/steve/MemberFileImportScripts
 R W    user/steve/netBeansUptraUnitTest
 R W    user/steve/testProject
 R W    user/steve/vMachineProj
 R W    web/www.warmemorialhospital.org
Connection to cvs2 closed.

This shows me all git repos on our gitolite server that are available to me and lets me know how I can create new ones. Anything with a R I can read Anything with a W I can write to and Anything with a C I can create. So here it will let me create new projects under prog, user/steve or web.

so to create a new project in web I can

git clone git@cvs2:web/newProject.git

or if I want to create projects that Only I have write access to I can create one in my own userspace

git clone git@cvs2:user/steve/myProject.git

You can add an existing git repo of yours to the gitolite server by adding a remote for it and pushing to it.

git remote add origin git@cvs2.gaslightmedia.com:web/www.yoursitename.com
git push origin --all

Reverting Commits

You just ran git push, sending your changes to GitHub, now you realize there's a problem with one of those commits. You'd like to undo that commit. Undo with: git revert <SHA> (get the SHA from gitk

git revert will create a new commit that's the inverse of the given SHA—anything removed in the old commit will be added in the new commit and anything added in the old commit will be removed in the new commit.

This is Git's safest, most basic "undo" scenario, because it doesn't alter history—so you can now git push the new "inverse" commit to undo your mistaken commit.

New Release Branch

git flow hotfix release

Tracking Branches

To set your current branch as a tracking branch (make sure you're on the branch that you run this command for)

git branch --set-upstream develop origin/develop
git branch --set-upstream master origin/master

Spiffy Shortcuts

Being able to see the last tag (clean) with the 'glt' command

edit your .bashrc. Add the following:

alias glt='git describe --abbrev=0'

Uncommon Commands

Removing a remote GIT repository

WARNING! Take GREAT caution using these commands. If you're not absolutely sure you should be using them, you should not be using them.

ssh git@cvs2 D unlock WP-Plugins/glm-sample-file-repo
ssh git@cvs2 D rm WP-Plugins/glm-sample-file-repo

Cleaning empty git repositories

Sometimes bad commits will be forgotten and accumulate empty repositories. Considering this involves deletion of data I've marked safe commands with blue, and dangerous commands with red. One person should compile a list of all empty or unwanted repos and prepend them with:

ssh git@cvs2 D unlock

This will then look like:

ssh git@cvs2 D rm WP-Plugins/glm-member-d-events

Considering the potential volume of unlock commands, it's a lot easier if these are perform in a single sequence. Here's an example of one we used on Jan 3, 2017:

ssh git@cvs2 D unlock WP-Plugins/glm-member-d-events;ssh git@cvs2 D unlock WP-Plugins/glm-member-db-evets;ssh git@cvs2 D unlock WP-Plugins/glm-member-search;ssh git@cvs2 D unlock WP-Plugins/glm_serverstats;ssh git@cvs2 D unlock WP-Themes/GruntInit/glmTheme;ssh git@cvs2 D unlock WP-Themes/francejourneys-theme;ssh git@cvs2 D unlock WP-Themes/glmThemes/camppetosega-theme;ssh git@cvs2 D unlock WP-Themes/mackinawcity;ssh git@cvs2 D unlock web/GruntInit/glmThemV6;ssh git@cvs2 D unlock web/StignaceBudgetHost;ssh git@cvs2 D unlock web/kiosk.pellstonairport

Everyone that uses git on the team will have to run this until each site has been accounted for For each one that is not yours it will say "You are not authorised". Otherwise it will say something akin to "'WP-Themes/mackinawcity' is now unlocked". That means you are able to delete it. Before running the next command below double-check that this is indeed the 'bad' repo, because this will destroy the repository immediately

 ssh git@cvs2 D rm WP-Themes/mackinawcity

Checking out files that are part of git

git archive --remote=git://git.foo.com/project.git HEAD:path/to/directory filename | tar -x

or (can also be used to restore a deleted file)

git show SHA-ID:path/to/file

Sources

How to undo almost anything with git

A successful Git branching model

Obsolete Commands

Installing Wordpress with git

Create a new folder for your site.

mkdir Project
git init

Install the git version of wordpress as a submodule

git submodule add git://github.com/WordPress/WordPress.git wordpress
git commit -m "Add Wordpress submodule"
cd wordpress
git checkout 4.0
cd ..
git commit -am "Checkout latest Wordpress version"

cp wordpress/wp-config-sample.php wp-config.php
cp wordpress/index.php .
cp -R wordpress/wp-content .

git add .
git commit -m "Moving config and content outside the submodule"

Do a git pull on master and checkout on all themes.

for dir in /var/www/server/wordpress/wp-content/themes/*; do (cd "$dir" && pwd && git checkout master && git pull --rebase && git checkout develop && git pull --rebase); done

The Great GLM Git Guide

Contents