wiki:faq/gitification

Version 5 (modified by Bart, 7 years ago) (diff)

Added core chapter

Gitification of Indymedia linksunten

Introduction

Until May 2012,Indymedia linksunten used the Good Old Fashioned Way™ to keep track of upstream changes to it's Drupal (in fact: Pressflow) core and modules: drush dl mymodule. At least in theory. In reality, the core has been patched twice, many modules even more and some self-written modules do not even exist in a public drupal repository. linksunten has some 80 modules installed and keeping track of updates is wearisome for the non-patched modules and troublesome for the patched ones. We learned that a version control system could ease the error-prone update procedure and as drupal.org has switched to git we decided to do the same.

Since a Drupal website is not a monolithic bloc and nearly each module is maintained by different developers we needed to find a way to update the core and each module separately from one another. The traditional way git offers for this is a concept called git-submodule. It is complicated, unintuitive and detested by many for good reasons. But as git follows the TMTOWTDI paradigm we could avoid using git-submodule and settled for git-subtree instead which has recently been merged into git core. Besides the possibility to update the core and each module separately and replaying our patches to the updated version automatically, we want the linksunten code to be one git repository which simply "works" after cloning it. After our move to git we will use the features module to version control as much of our configuration data as possible.

Drupal core

We create a new directory, initialise git, tell git which name and email to use, create a temporary file which we commit, delete and commit again to create a master branch:

mkdir liu_d6
cd liu_d6
git init
git config user.name "Indymedia linksunten"
git config user.email "línksunten@índymedía.org"
touch liu_d6
git add liu_d6
git commit -m "Initial commit Indymedia linksunten Drupal 6."
git rm liu_d6
git commit -m "Created master branch."

We don't want the settings.php file in our repository as it contains database login credentials so we tell git to exclude it:

echo /settings.php >> .git/info/exclude

We add Pressflow 6 as a new remote and fetch it:

git remote add pressflow-6.x git://github.com/pressflow/6.git master
git fetch pressflow-6.x

Now we can add Drupal core from our pressflow-6.x remote via git-subtree in a subdirectory core. We use the --squash parameter as we do not need the whole commit history of Pressflow in our master branch:

git subtree add --squash --prefix=core pressflow-6.x/drupal-6.26

As we are creating a production environment, we'll delete some of the unnecesary files:

git rm core/install.php core/*.txt
git commit -m "Delete install.php and text files from core directory."

We copy our settings.php to our repository directory, create a symbolic link from inside the core and delete the default.settings.php

cp ~/settings.php .
cd core/sites/default
ln -s ../../../settings.php
git rm default.settings.php
cd ../../../
git add core/sites/default/settings.php
git commit "Add symbolic link to settings.php."

There are some more modifications to do but they are really linksunten specific (like applying the two core patches via git am which have been created via git format-patch before) so we leave them out.