This is a Drupal 8 site built using the robo taskrunner.
First you need to install composer.
brew install composer
Next add ./vendor/bin
to your PATH, at the beginning of your PATH variable, if it is not already there (only if not using a new Bene install)
Check with:
echo $PATH
Update with:
export PATH=./vendor/bin:$PATH
You can also make this change permanent by editing your ~/.zshrc
or ~/.bashrc
file:
export PATH="./vendor/bin:...
Go to github https://github.com/new and create a new repository. The script expects an empty repository. Do not put anything in it or the script will fail.
From within your ~/Sites directory run:
git clone git@github.com:thinkshout/.git
cd
composer install
Test are run automatically on CircleCI, but can be run locally as well with:
robo test
With composer require drupal/{module_name}
you can download new dependencies to your
installation.
composer require drupal/devel:8.*
If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the composer-patches plugin.
To add a patch to drupal module "foobar" insert the patches section in the extra
section of composer.json:
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL to patch"
}
}
}
This project will attempt to keep all of your Drupal Core files up-to-date; the project drupal-composer/drupal-scaffold is used to ensure that your scaffold files are updated every time drupal/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modfied files are updated in a new release of Drupal core.
Follow the steps below to update your core files.
- Run
composer update drupal/core --with-dependencies
to update Drupal Core and its dependencies. - Run
git diff
to determine if any of the scaffolding files have changed. Review the files for any changes and restore any customizations to.htaccess
orrobots.txt
. - Commit everything all together in a single commit, so
web
will remain in sync with thecore
when checking out branches or runninggit bisect
. - In the event that there are non-trivial conflicts in step 2, you may wish
to perform these steps on a branch, and use
git merge
to combine the updated core files with your customized files. This facilitates the use of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple; keeping all of your modifications at the beginning or end of the file is a good strategy to keep merges easy.
Running the robo configure
command will read the .env.dist, cli arguments and
your local environment (DEFAULT_PRESSFLOW_SETTINGS
) to generate a .env file. This file will be used to set
the database and other standard configuration options. If no database name is provided, the project name and the git branch name will be used. If no profile name is provided, "standard" will be used. Note the argument to pass to robo configure can include: --db-pass; --db-user; --db-name; --db-host; --profile.
robo configure --profile=bene
# Use an alternate DB password
robo configure --profile=bene --db-pass=<YOUR LOCAL DATABASE PASSWORD>
# Use an alternate DB name
robo configure --profile=bene --db-name=<YOUR DATABASE NAME>
The structure of DEFAULT_PRESSFLOW_SETTINGS
if you want to set it locally is (set by default for new repos):
DEFAULT_PRESSFLOW_SETTINGS_={"databases":{"default":{"default":{"driver":"mysql","prefix":"","database":"","username":"root","password":"root","host":"localhost","port":3306}}},"conf":{"pressflow_smart_start":true,"pantheon_binding":null,"pantheon_site_uuid":null,"pantheon_environment":"local","pantheon_tier":"local","pantheon_index_host":"localhost","pantheon_index_port":8983,"redis_client_host":"localhost","redis_client_port":6379,"redis_client_password":"","file_public_path":"sites\/default\/files","file_private_path":"sites\/default\/files\/private","file_directory_path":"site\/default\/files","file_temporary_path":"\/tmp","file_directory_temp":"\/tmp","css_gzip_compression":false,"js_gzip_compression":false,"page_compression":false},"hash_salt":"","config_directory_name":"sites\/default\/config","drupal_hash_salt":""}
Running the robo install command will run composer install to add all required dependencies and then install the site and import the exported configuration.
robo install