For every site a make file

For every site, a .make file
Jeff Miccolis
25. aug 10:00
vps.net

Wednesday, August 25, 2010

I build drupal sites
I co-maintain Open Atrium
I contribute to drush_make


You build drupal sites
You’ve heard of drush
You’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
speciﬁc SVN repository.
The standard way of deploying drupal...


...and then using that SVN
repository to “manage”
production.


...is a heck of a lot
better than nothing.


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


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


The last ‘stable’ release
doesn’t work with php 5.3


Chances are you’re
using a CVS checkout.


With a patch (or two)
applied.


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.


We can improve the
‘standard way’


Duplicative repositories
Problems with the standard way...


Logs that mix of upstream
ﬁxes and custom work


Too much detective
work.


Doesn’t make upstream
contributions easy.


Makes hacking
upstream projects easy.


b) Tools


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


CLI?!?!
WTF?!?!


Fast and scriptable.


**DRUSH_ DEMO**


Drush Make
http://drupal.org/project/drush_make


It’s how we package install
proﬁles on drupal.org
drush_make is...


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


This means it doesn’t
need a Drupal site.


Installed in ~/.drush
drush_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 ﬁle is a
manifest for your site.


core = 6.x
projects[] = drupal


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


; This is a comment
;
; In short .make ﬁles use
; .info ﬁle 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 ﬁle automatically?
Question.


Text

http://drupal.org/project/cck

Projects vs. Modules
Answer.


What about bugs in
contrib module?
Question.


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


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.

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


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


Can I reuse snippits of
make ﬁles somehow?
Question.


Yes, two ways;
recursion & inclusion.
Answer


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


Recursion: Avoid it.*
Rarely useful, mostly
confusing.
*except with install proﬁles.


Inclusion: Allow a make
ﬁle to reference
another make ﬁle.


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


; Include Open Atrium
includes[openatrium] = http://...

; Include Open Atrium
includes[openatrium] = http://drupalcode.org/viewvc/drupal/contributions/proﬁles/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 ﬁles are portable.
They’re manifests, not a personal ‘save’ button


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


Use comments &
Link patches
A few words can help a lot.


Proﬁle .make
vs.
Distro .make


Used to make an install
proﬁle. No Core.
proﬁle .make


It’s what we use on
Drupal.org
proﬁle .make


Includes core.
distro .make


Is what I use for
Openatrium.com
distro .make


The distro .make
retrieves and builds the
proﬁle.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 proﬁle.
You’r new project repository.


Custom themes and
modules.
Your new project repository.


A rebuild script.


Nothing that already
has a home.


Forking projects and
contributing back.
Forking for karma.


The patches in your make
ﬁle 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


For every site a make file

Recommended

Recommended

More Related Content

Similar to For every site a make file

Similar to For every site a make file (20)

More from Development Seed

More from Development Seed (16)

Recently uploaded

Recently uploaded (20)

For every site a make file