for every site a make file

vps.net25. aug 10:00

For every site, a .make file

Jeff Miccolis

Wednesday, August 25, 2010

I build drupal sitesI co-maintain Open AtriumI contribute to drush_make


You build drupal sitesYou’ve heard of drushYou’ve had deployment issues


If I’m lucky, you’ve used the Features module.


Problems, Tools, Gotchas...and your questions


a) Problems


The reality of deploying and maintaining drupal is ugly.


The standard way of deploying drupal...


...involves committing everything to a project specific SVN repository.The standard way of deploying drupal...


...and then using that SVN repository to “manage” production.The standard way of deploying drupal...


...is a heck of a lot better than nothing.The standard way of deploying drupal...


But what version of the Date module are you using there?


The last ‘stable’ release was September 16th, 2009Which version of Date module is that?


The last ‘stable’ release doesn’t work with php 5.3Which version of Date module is that?


Chances are you’re using a CVS checkout.Which version of Date module is that?


With a patch (or two) applied.Which version of Date module is that?


Do you know where your children are?


...and to make matters worse...


SA-CONTRIB-2010-666** not real **


...and you haven’t seen this site in 4 months.

**happens all the time**


The kids are in trouble.


We hack our way through. Commit semi-random patches and `svn co` production.The standard way of deploying drupal...


We can improve the ‘standard way’


Duplicative repositoriesProblems with the standard way...


Logs that mix of upstream fixes and custom workProblems with the standard way...


Too much detective work.Problems with the standard way...


Doesn’t make upstream contributions easy.Problems with the standard way...


Makes hacking upstream projects easy.Problems with the standard way...


b) Tools


Drush, Command line Drupal.http://drupal.org/project/drush


http://drupal.org/project/drush

http://drupal.org/project/drush

CLI?!?! WTF?!?!


Fast and scriptable.


**DRUSH_ DEMO**


Drush Makehttp://drupal.org/project/drush_make


http://drupal.org/project/drush_make

http://drupal.org/project/drush_make

It’s how we package install profiles on drupal.orgdrush_make is...


Not a Drupal module, a Drush extension!drush_make is...


This means it doesn’t need a Drupal site.


Installed in ~/.drushdrush_make is...


Used to make a ready to install Drupal platform.drush_make is...


Doesn’t Drupal come ‘ready to install’?


...when was the last time you deployed ‘just Drupal’?


Drupal core + views + cck + date...and probably a lot more.


A .make file is a manifest for your site.


core = 6.xprojects[] = drupal


projects[cck][subdir] = "contrib"projects[cck][version] = "2.8"


; This is a comment;; In short .make files use; .info file formatting.;; Also drush_make has a great; README.txt


projects[date][type] = "module"

projects[date][download][type] = "cvs"

projects[date][download][module] = "contributions/modules/date"

projects[date][download][revision] = "DRUPAL-6--2:2010-06-20"


projects[litecal][type] = "module"

projects[litecal][download][type] = "git"

projects[litecal][download][url] = "git://github.com/./litecal.git"


**DRUSH_MAKE DEMO**


Why can’t you generate the make file automatically?Question.


Text

http://drupal.org/project/cckWednesday, August 25, 2010

http://drupal.org/project/cck

http://drupal.org/project/cck

Projects vs. ModulesAnswer.


What about bugs in contrib module?Question.


Answer.

projects[prepopulate][patch][] = "http://../360613_20100812.patch"


http://drupal.org/files/issues/360613_20100812.patch

http://drupal.org/files/issues/360613_20100812.patch

What about random javascript libraries?Question.


libraries[jquery_ui][download][type] = "get"

libraries[jquery_ui][download][url] = "http.."

libraries[jquery_ui][directory_name] = "jquery.ui"

libraries[jquery_ui][destination] = "modules/contrib/jquery_ui"

Answer.


http://jquery-ui.googlecode.com/files/jquery.ui-1.6.zip

http://jquery-ui.googlecode.com/files/jquery.ui-1.6.zip

Isn’t it slow to do all this downloading?Question.


Finally, a useful purpose for squid!http://reluctanthacker.rollett.org/node/114


http://reluctanthacker.rollett.org/node/114

http://reluctanthacker.rollett.org/node/114

Can I reuse snippits of make files somehow?Question.


Yes, two ways; recursion & inclusion.Answer


Recursion: if a project has a .make file it will be run.


Recursion: Avoid it.*Rarely useful, mostly confusing.*except with install profiles.


Inclusion: Allow a make file to reference another make file.


Inclusion: Use it.References via URLs, items in the referenced file can be overridden.


; Include Open Atriumincludes[openatrium] = http://...

; Include Open Atrium includes[openatrium] = http://drupalcode.org/viewvc/drupal/contributions/profiles/openatrium/openatrium.make?view=co&pathrev=HEAD


http://drupalcode.org/viewvc/drupal/contributions/profiles/openatrium/openatrium.make?view=co&pathrev=HEAD






Use overrides to grab CVS checkouts, experimental forks, more recent versions, etc


Ok, cool. How do I use this again?


**BUILDKIT DEMO**


c) Gotchas, best practices, concepts, etc...


Make files are portable.They’re manifests, not a personal ‘save’ button


Tag versions.If your make file is pointing at HEAD it’s not doing it’s job.


Use comments &Link patchesA few words can help a lot.


Profile .make vs. Distro .make


Used to make an install profile. No Core.profile .make


It’s what we use on Drupal.orgprofile .make


Includes core.distro .make


Is what I use for Openatrium.comdistro .make


The distro .make retrieves and builds the profile.make.distro .make


This is the one place the recursion behavior works for us.distro .make


Small scripts go a long way.Like Open Atrium’s rebuild.sh


You’ll still want a project repository.


An install profile.You’r new project repository.


Custom themes and modules.Your new project repository.


A rebuild script.Your new project repository.


Nothing that already has a home.Your new project repository.


Forking projects and contributing back.

Forking for karma.


The patches in your make file need to be public.

Forking for karma.


Write patches that have a chance...

Forking for karma.


Post them on the project’s issue queue.

Forking for karma.


What if everyone did this?

Forking for karma.


In conclusion, two things;


a) I don’t ever want to wonder; did we apply that patch to this site?


b) patches belong upstream. Let’s keep them there.


Questions?


http://cph2010.drupal.org/node/14588


http://cph2010.drupal.org/survey/42

http://cph2010.drupal.org/survey/42

for every site a make file

Technology

drupal module

doesnt drupal

drupal core

drupal sitesyouve

drupal platform

make file

command line drupal

drupal sitesi co