Set of bash scripts and configuration files to install, reset, upgrade, backup, restore and build a Drupal project without the need to have Core and Contributed code in the repository.
The name "druleton" is a combination of drupal and skeleton.
See the quick-start guide how to install druleton.
Druleton provides commands to create a new site and support in development and deployment.
Each command has a help section that explains the options for it. View the help
by running the command with the -h switch.
Example:
$ bin/install -hThe bin/init command is used to setup the druleton environment.
It will check the project file structure and create the missing parts.
It will download tools like composer and add them to the bin directory. It
will also scan the config/bin directory if there are custom, project specific,
commands and add them to the bin directory.
You can run this command anytime, it will update the tools and rescan the
config/bin directory.
$ bin/initMore information about this command.
The bin/install command will download Core & Contributed (modules, themes &
libraries) as defined in the make file(s), and will install the website with
the settings in the config/config.sh file.
When the installation is finished, a browser will be opened and you will be logged in as platform administrator (user 1).
If there is already a working installation, a backup of it will be taken.
$ bin/installMore information about this command.
The bin/reset command will do the same as install without downloading the Core
and Contributed projects. Use this to reset an already installed website to its
fresh-install state.
A backup will be taken before the reset is run.
The sites/default/settings.php file, the sites/default/files directory and
the database will be removed before the site is reinstalled.
$ bin/resetMore information about this command.
The bin/upgrade command will download Core & Contributed code based on the
make files and run the update-db command. Use this to update core and
contributed to their latest version or to apply a patch.
A backup will be taken before the reset is run.
The existing settings.php, files directory and database will be kept.
$ bin/upgradeMore information about this command.
The bin/build command will create a deployment package (code) in the /build
directory.
$ bin/buildMore information about this command.
The bin/backup command will take a backup of the web directory and the
database. The backup will be stored in the backup directory.
You can limit the backup to just the web or files directory or just the database by passing them as arguments.
$ bin/backupMore information about this command.
The bin/restore command will list the available backups from the backup
directory and let you choose which one to restore. It will restore the /web
directory and the database.
If there is a working environment: a backup of it will be created before the restore is run.
$ bin/restoreMore information about this command.
The bin/composer command is a wrapper around the composer.phar binary.
$ bin/composerMore information about this command.
The bin/drush command is a wrapper around drush. It will always run the drush
command within the web directory.
$ bin/drushMore information about this command.
The bin/coder command is a wrapper around the phpcs (PHP Code Sniffer)
binary. It has the proper default settings for the Drupal standards.
$ bin/coderMore information about this command.
The bin/init command will download and install composer locally. It can be
called using following command:
$ bin/composer
It is possible to add your own, project specific, commands.
See the custom commands documentation.
Each command has a set of steps it runs trough. All the code related to those
steps are located in the bin and bin/src directories. This code should not
be altered/hacked.
Druleton provides hooks that are called before and after each step so extra scripts can be added and run.
The hooks can be implemented only for specific environments by adding the environment name as postfix to the hook.
See hooks documentation.