The Lazy Maintainer's Handbook, Part 1: Frequent Releases
Every now and then I think about writing a series of posts called 'The Lazy Maintainer's Handbook', covering various aspects of how to maintain a project (or several) on drupal.org without it being a huge burden on your time (which a lot of people, and companies, think is the case). However, I never get much past the pondering stage. Since it's safe to say that I'm never going to manage to come up with the right order to write these in, I'm just going to start in the middle. Here goes.
Like with all software, bugs are a problem in the world of Drupal. In Drupal contrib, like with any software that has releases, we can classify bugs into three types:
- bugs which are reported, but have no fix,
- bugs which have a fix, but the patch hasn't been committed,
- bugs which have been fixed, but are not part of a release yet.
The first and second type can involve a fair amount of work, and I will cover in another post in the future how much a LM can or should do about them.
The third type though is where the LM can really shine: all that needs to be done here is to make a release. What could be simpler? And let's be clear, making a release is a very quick job. I can do the whole thing in about a minute (though I've not timed it, yet).
For one thing, if you're still writing the release notes by hand, then stop: Git Release Notes for Drush does that for you.
Here's my process:
$ git tagThis lists all the existing tags, so I can see what the next release number should be.
$ git tag 7.x-1.2This creates the tag for the new release.
- At this point, it's a good idea to check this in a graphical git client, to check for stupid mistakes like making the tag on a local development branch, or the wrong major branch. (I've done that at least once.)
$ git push origin 7.x-1.2This creates the tag on the remote repository.
$ drush release-notesThis creates the release notes, using all the commit messages between the previous commit and the commit you just made. (Another reason to use the standard format for commit messages: it will turn the #12345 issue numbers into tags for d.org to then render as links.)
- Select the output from the command and copy it.
- Go to your project's page on d.org and click the 'Add new release' link.
- Select the new tag.
- Paste the release notes and save the node.
I speed this up even more by having a bash alias for 'drush release-notes | pbcopy', which on OS X puts the text output by the Drush command onto the clipboard, so I can skip the selecting and copying step.
It's quick, right? Fun, even! Why don't maintainers do it more often? The reasons I can think of are:
- the current branch HEAD (and thus -dev release) is unstable and badly broken
- maintainers are worried about making releases too frequent and making site builders update all the time
- maintainers have fallen prey to the 'just one more fix' syndrome, and are waiting for another issue (or issues) to be resolved.
Let's address these shall we?
The branch is unstable
This can happen when you're still on alpha releases, and something's caused you to take a new direction in development. This is a tough case: there's no going back, and you're stuck going forward. The only thing I would advise here is to look at the git history since the last release and see if there's a commit between then and now that could be tagged as the next alpha: for instance if the first few commits after the alpha were simple bug fixes. To try to prevent this problem, I recommend making a release immediately before you take a new direction in development, and if it's a very large rewrite, starting a new major branch, even if that means abandoning the 1.x branch at the alpha stage.
If a major rewrite happens and you're on beta releases or stable releases, then you're doing it wrong: a major rewrite should be cause to start a new major branch.
The last release was recent, and users may dislike frequent releases
Inspecting and testing new releases takes time. More importantly, perhaps, it has quite a high cognitive cost, as for each module you update, you need to review the release notes to look for any changes that might affect your site's functionality, and any parts of your site's codebase that make use of that module's code. It's also a bit stressful, because if something does break, it could be in a part of the site you don't think to check, so the first you'll hear of it is when your client or project manager calls in a panic two days later.
Understandably then, a lot of developers and site builders put off module updates, or don't bother with them until there's a security release.
This may be a time saving, but I don't believe it's an effort saving. Suppose you're on release 1.0 and releases 1.1 and then 1.2 come along. You can either upgrade to each one when it comes out, or you wait for 1.2 and then upgrade straight to that.
Doing two upgrades seems like more work, because you're only having to check the site once.
But I would counter that it's less overall cognitive load, because each single release has fewer changes. If releases are frequent, and include only up to a dozen or so commits, then it's easier to scan down the list of issues in the release notes, and maybe see that they're all very minor bug fixes, or clearly only affect functionality that your site doesn't use.
Ultimately, I don't think postponing upgrades pays off, because eventually, you'll have to bite the bullet and upgrade past several version numbers. Worse, you may have your hand forced when a security update comes along, and you'll be in the situation of having to read the release notes for all the versions you skipped and assessing them, while your site is on fire.
So I think small, frequent releases are actually a good thing, even from the point of view of existing users.
From the point of view of new users, they're a great thing: new users get better code, with fixed bugs. And that applies to existing users as well of course.
(A future episode in this series will cover an idea I've had for ages, of a metric for when you should do a release: after so many commits or weeks have passed.)
You're waiting for just one more fix
Don't. It might never come. In my experience, it probably won't. You'll think to yourself, 'just one more week and someone will review this patch', or 'I'll write a patch for this in the next week'. That week becomes two, and a month, and a year, and even more. I've seen comments on issues called 'Plan for a 1.0 release' where the maintainer says 'I'll make a release in the next two weeks' and that comment is over a year old. I saw one of those comments recently that was two years old. It was mine.
Fight the urge to wait for more fixes. Yes, you want your module to be good, even maybe perfect. But tell yourself: if you release now, you're still making it better. So here's what you need to do:
- If you're still not on a stable release, release another alpha or beta. The real purpose of unstable releases should be to get people to test your code. You really want them to be testing something recent, not code that's six months old.
- If you're on stable releases, just release another one. Those issues you were waiting for can go in the next release (or the one after…)
Hopefully that should assuage concerns regarding one's responsibility as a maintainer.
But as a lazy maintainer, what's the benefit to you?
- Your recent fixes are out there and in use. A bug isn't truly eradicated until a release is made that includes the fix.
- Fewer duplicate issues filed. With fewer bugs that are fixed in dev but not in a release, there's less chance of people encountering them.
- More users, because the age of the most recent release is a metric people use when evaluating a module.
- Users are using a more recent version of the code, which means newer bugs are more likely to get caught. (Because seriously, how many people are actually trying out the dev release, unless they're forced to by unreleased fixes?)
Get the code out. Dev code serves nobody. Releases are what matters.