For the past few weeks, I've been working on a new side project: Herald.
The reason behind this was my frustration with unclean, unprofessional code. I work on code-bases written by many different people, some of who produced horrible, undocumented code, with no consistent styling or standard whatsoever (I mean, one-space indentations?? Or indenting a whole PHP file??)
I checked Jenkins and others, but obviously these (great) products are made to cater many different frameworks and languages. And I thought:
Wouldn't it be cool to have a Drupal-specific system, simple and straightforward to install and use, so teams can start producing quality code?
Why another product
Why not? New products come out every day. I searched for a Drupal-specific tool, but couldn't find any. Even no free, open source tools. I did stumble upon Review Driven, but it looks dead, and I didn't really like the logic of it.
Of course, Herald doesn't re-invent the wheel completely. It's goal is to build upon existing technology and projects, and simply group it all together in an easy to use, straightforward package.
For example, Herald can check Drupal coding standards. It simply uses Coder to achieve this. Same goes for checking CSS or JS syntax: it uses CSSLint and ESLint, respectively (aligning itself with tools that Drupal 8 encourages developers to use).
How it works
Herald is split up into small, modular components. At it's core lies the Herald Core module. This module provides a simple but flexible API for managing projects, builds and tasks.
A project is typically a Drupal module or theme (or even distribution). It has some basic settings, like what kind of tasks to run on each build.
A build is, just as for other CI systems, a specific point in the project history (usually a commit in the CVS). Herald provides a flexible API to get these builds, and out-of-the-box, it can create builds from private Git repositories (through a webhook) and build from Drupal.org repositories (regularly pulling code).
As soon as a build is registered (“created”), tasks can be registered. Each registered task is then queued, waiting for Herald Core to execute it.
Herald ships with several submodules:
- Herald Drupal Code Standards: makes sure code respects the Drupal Coding Standards.
- Herald CSSLint: makes sure CSS files respect a given standard (defaults to the D8 standard).
- Herald ESLint: makes sure JS files respect a given standard (defaults to the D8 standard).
- Herald Drupal.org Git Integration: regularly pull new code from Drupal.org repositories (Drupal.org currently has no support for Git hooks).
- Herald Private Git Integration: react on a URL callback, usable with Git hooks, allowing new builds to be created on a Git push.
- Herald UI: Provides integration with Chart.js to provide some nice widgets.
- Herald Simpletest: A hidden module (for now), which can run unit tests inside a Docker container.
How to use it
First, please understand this is under heavy development! It is not yet fully stable, and I recommend only using it on internal servers, not servers that are accessible to the public.
If you want to use the provided build systems, make sure you install Git on your server.
The Simpletest runner is not ready for production yet, and could pose security risks if not used properly! That is why it can only be enabled through the command line, via Drush (
drush en herald_simpletest). If you wish to use the Simpletest runner, you need to install Docker.
If you think this sounds like a good idea and you want to see it evolve, please contribute to the project. You can contact me, or follow me on Twitter and DM me there. Herald is still in its infancy, and will require a lot of love to grow to something awesome. If you've used projects like Aegir before, you know how awesome Drupal-powered systems can be.
Found a typo ? Correct it, submit a pull-request and get credited here!