Guidelines for packaging Drupal 8 modules, themes, and profiles
Different Kinds of Packages
- Modules: Modules extend and customize Drupal functionality.
- Themes: Themes allow users to change the look and feel of their Drupal site.
- Distributions/Profiles: Distributions/profiles provide site features and functions for a specific type of site.
Naming Scheme
Every package MUST be named drupal8-<drupal_project>. Drupal itself enforces unique project names for each of its' projects and there is a single namespace for all modules, themes, and distributions/profiles. The <drupal_project> MUST match the drupal.org project name (i.e. drupal.org/project/<drupal_project>).
File Placement
- Modules: A module package MUST be placed in the
%drupal8_modulesdirectory - Themes: A theme package MUST be placed in the
%drupal8_themesdirectory - Distributions/Profiles: A distribution/profile package MUST be placed in the
%drupal8_profilesdirectory - Libraries: A library package MUST be placed in the
%drupal8_librariesdirectory
Requires and Provides
Every package MUST include the following in its' spec:
BuildRequires: drupal8-rpmbuild
The drupal8-rpmbuild package automatically scans files for provides [1] and requires [2] and automatically adds them to the package during build time as "drupal8(<drupal_project>)" and "php-composer(<vendor>/<project>)" virtual resources. The use of virtual provides and requires helps alleviate the confusion of sub-modules and which modules actually provide those sub-modules. They also help simplify spec files.
[1] From *.info.yml and composer.json filenames
[2] From *.info file "dependencies" entries
Other Packages
PHP Extensions
Requiring a Minimum PHP Version
See PHP packaging guidelines but note that this should not normally be required by most packages (see [1]).
drupal8-rpmbuild package so it is automatic.Macros and Scriptlets
Macros provided by the drupal8-rpmbuild package:
| Macro | Value | Description |
|---|---|---|
%drupal8_version |
8.x.y* | Drupal 8 version. * Value is dynamically updated by the Drupal 8 core package. |
%drupal8 |
%{_datadir}/drupal8 |
Drupal 8 base directory. |
%drupal8_modules |
%{drupal8}/modules |
Drupal 8 modules directory. |
%drupal8_profiles |
%{drupal8}/profiles |
Drupal 8 profiles directory. |
%drupal8_themes |
%{drupal8}/themes |
Drupal 8 themes directory. |
%drupal8_libraries |
%{drupal8}/libraries |
Drupal 8 library directory. |
%drupal8_var |
%{_localstatedir}/lib/drupal8 |
Drupal 8 var directory. |
%drupal8_conf |
%{_sysconfdir}/drupal8 |
Drupal 8 conf directory. |
Additional Hints
Templates
%global drupal_project __DRUPAL_PROJECT__
Name: drupal8-%{drupal_project}
Version: __VERSION__
Release: 1%{?dist}
Summary: __SUMMARY__
Group: Applications/Publishing
License: GPLv2+
URL: https://www.drupal.org/project/%{drupal_project}
Source0: https://ftp.drupal.org/files/projects/%{drupal_project}-8.x-%{version}.tar.gz
BuildArch: noarch
BuildRequires: drupal8-rpmbuild
%description
__DESCRIPTION__
This package provides the following Drupal project(s):
* %{drupal_project}
%prep
%setup -qn %{drupal_project}
: Licenses and docs
mkdir -p .rpm/{licenses,docs}
mv LICENSE.txt .rpm/licenses/
mv composer.json .rpm/docs/
%build
# Empty build section, nothing to build
%install
mkdir -p %{buildroot}%{drupal8_modules}/%{drupal_project}
cp -pr * %{buildroot}%{drupal8_modules}/%{drupal_project}/
%files
%license .rpm/licenses/*
%doc .rpm/docs/*
%{drupal8_modules}/%{drupal_project}
%changelog
* ddd MMM DD YYYY __NAME__ <__EMAIL__> __VERSION__-1
- Initial package