Aegir consists of a number of components each living in their own Git repository.
This document is intended to give some guidelines as to what should go where. It's intended for Aegir core, but we welcome any contributed project to follow. Just to have some consistency.
- Drupal.org is the canonical repository for the stable branches and releases.
- Issues should be on Drupal.org
- Feature branches can best be pushed to GitHub or GitLab to facilitate testing with Travis or GitLab CI.
- Pull Requests on GitHub are very welcome, please just add a link to them in an issue on Drupal.org.
3.x - current stable Drupal 7 frontend, Drush and provision. (maintainer: helmo)
4.x - The next development step, to go beyond Drush (maintainer: jon_pugh)
5.x - Aegir NG, Drupal 8, new queue and modernized backend (maintainers: ergonlogic, colan)
All core maintainers can work on these branches, however the noted maintainer for each branch is often the first to contact and the most involved in that particular area.
For the current stable release we have 7.x-3.x as the main branch for all the core projects. This follows the Drupal 7 default.
Feature branches can best be prefixed with 'feature/' resulting in 'feature/[issue number]-some-change'. Pushing them to GitHub and creating a PR for it lets us test the results with Travis. These feature branches don't have to be pushed to D.o, and can be removed after being merged.
- When a PR is not ready you can prefix the title with:
We started adding more modules during the 3.x cycle and invented the Golden Contrib name for it.
The idea is to package modules that extend Aegir to make them easier to install. Their descriptions are listed on the Contributed Projects page.
These are included from our makefiles and end up in
Golden contrib module guidelines
- It should have a full release on Drupal.org
- It should be covered by the security team.
- There should be the intention to maintain the module for the longer term, at least as long as the current stable Aegir release.
- All Aegir core maintainers should have access to the module project on Drupal.org. However, a minimum of two is required at all times. Use the current maintainers list for reference.
- Where appropriate it should include a file for Aegir's feature system. E.g. hosting.feature.modulename.inc
- It should be security reviewed by other core maintainers, keeping the following in mind:
- The module should not increase the system's attack surface.
- If it does, a strong warning must be provided in the description.
- It should not encourage users to perform dangerous operations, from which there is no recovery. If such features are requested, their use must come with warnings.
TODO's when adding a module
- Create a release with the same version string as the current Aegir stable. Having this helps the automated search/replace in the makefiles during a release.
- Add to drupal-org.make
Add to hostmaster.make
Add to docs/extend/contrib.md, or move to the Golden Contrib section.
- Add extra link in the Creating release nodes on Drupal.org section
- Add in release.sh
- Add in release_notes.sh