DEVELOPING.md

Local development environment setup

Quick setup

A simple setup is enough for most users to start contributing to Automatic Updates. For advanced needs, see Customizing your setup and Alternative setup options.

Assuming you meet the system requirements, simply run the following command ^{1(#footnote-1), 2(#footnote-2)} from the directory you would like to install your development environment under ^{3(#footnote-3)}. It will prompt for confirmation before beginning.

/bin/bash -c "$(curl -fsSL https://git.drupalcode.org/project/automatic_updates/-/raw/8.x-2.x/scripts/setup_local_dev.sh)"

That's it. The success message will display next steps.

Details and options

---

• System requirements
• Caveats
• Customizing your setup
• Alternative setup options
• Maintaining your environment

---

System requirements

• A *nix-based operating system, such as Linux or macOS.
• PHP 7.4 or later.
• Composer 2 or later. (Automatic Updates is not compatible with Composer 1.)
• Git must be installed.

Caveats

• Symbolic links are not currently supported by Package Manager. If the Drupal core checkout created during setup below contains any, tests will not work. By default, there shouldn't be any, but some may exist in certain situations (for example, if Drush or Drupal core's JavaScript dependencies have been installed).
  
  To scan for symbolic links, run find . -type l from the Drupal core repository root. If you find any, try to identify their source and eliminate it (for example, by removing a Composer library that places them).

Customizing your setup

Several details of your setup can be customized via environment variables. Set these before running the installation command above.

DRUPAL_CORE_BRANCH="9.5.x" # The branch of Drupal core that will be installed.
DRUPAL_CORE_SHALLOW_CLONE="TRUE" # Whether or not to do a "shallow clone" of Drupal core. (Defaults to TRUE.) See note below.
AUTOMATIC_UPDATES_BRANCH="8.x-2.x" # The branch of the Automatic Updates module that will be installed.
SITE_DIRECTORY="auto_updates_dev" # The path to the directory where the dev environment will be installed.
SITE_HOST=".test" # The path for Drupal's TRUSTED_HOST_PATTERN.

Note: A shallow Git clone is much smaller and therefore faster, but it removes the ability to do debugging operations such as git bisect or git blame. To recover these abilities, you can convert your repository to a full clone after the fact:

cd auto-updates-dev
git fetch --unshallow

Alternative setup options

You can download the setup script first to review its contents or modify it before running it:

curl --output setup_local_dev.sh https://git.drupalcode.org/project/automatic_updates/-/raw/8.x-2.x/scripts/setup_local_dev.sh

./scripts/setup_local_dev.sh

You can clone the whole repository:

git clone https://git.drupalcode.org/project/automatic_updates.git
cd automatic_updates

./scripts/setup_local_dev.sh

To set up your environment manually, use the setup script as a reference.

Maintaining your environment

• If you want to switch to a different branch of Drupal core during development or if you delete the vendor directory, you may will need to do this step again after running composer install.
• DO NOT delete the automatic_updates module or the modules directory it is in or you will lose any code changes forever. As appropriate, commit them and push them to a remote first--unless you don't care about keeping them. (Don't forget branches other than the one you have checked out.)

---

¹ When running a script downloaded from the Web, it is always wise to read its contents first. Ours (setup_local_dev.sh) is documented with code comments to help with that. For a more cautious approach, see Alternative setup options above.

² Curl options explained: -f, --fail, -s, --silent, -S, --show-error, -L, --location.

³ For example, run it in ~/Projects to create your environment at ~/Projects/auto-updates-dev or /var/www to create it at /var/www/auto-updates-dev. See Customizing your setup to override this behavior.