PhpRiot
News Archive
PhpRiot Newsletter
Your Email Address:

More information

Magento Extension GitIgnore Stub

Note: This article was originally published at Planet PHP on 18 April 9300.
Planet PHP

As you may or may not know, I've been working with Magento lately. In the past few months, one thing I've found that I needed is a stock .gitignore file for when making extensions. Haven't found one so I made one on github and will also post here for anyone else in need. I'm still relatively new at working with Magento and in someways git/github so please feel free to critique/streamline.


# replace {company} and {extension} placeholders with your information

# ignore phpstorm files
/.idea

# Ignore all not in app & skin
/*
!/app/
!/js/

# ignore all in js, except module files for this module
/js/*
!/js/{company}/

# Ignore all in app, except code & etc
# Ignore all in app/code except /local/{company}
/app/*
!/app/code/
!/app/etc/
!/app/design/

# Ignore all in app/code/local except {company}
/app/code/core
/app/code/community
/app/code/local/*
!app/code/local/{company}/
# use lines below if you have multiple company extensions
# and want to just commit a specific one
#/app/code/local/{company}/*
#!app/code/local/{company}/{extension}

# Ignore all of app/etc except our specific module files
/app/etc/*
!/app/etc/modules/
/app/etc/modules/*
!/app/etc/modules/{company}_{package}.xml

#Ignore all of app/design except for our files
/app/design/*
!app/design/frontend/
!app/design/adminhtml/
/app/design/frontend/*
!/app/design/frontend/base/
/app/design/frontend/base/default/etc/
/app/design/frontend/base/default/template/*
!/app/design/frontend/base/default/template/{extension}/
/app/design/frontend/base/default/layout/*
!/app/design/frontend/base/default/layout/{extension}/*
/app/design/adminhtml/*
!/app/design/adminhtml/default/
/app/design/adminhtml/default/find/
/app/design/adminhtml/default/default/etc/
/app/design/adminhtml/default/default/locale/
/app/design/adminhtml/default/default/template/*
!/app/design/adminhtml/default/default/template/{extension}/
/app/design/adminhtml/default/default/layout/*
!/app/design/adminhtml/default/default/layout/{extension}/*