Skip to content

Latest commit

 

History

History
216 lines (153 loc) · 12 KB

Installing-Sage.md

File metadata and controls

216 lines (153 loc) · 12 KB
Raw

Installing Roots Sage

Introduction

Roots Sage is an advanced WordPress starter theme with a modern development workflow. It's built with Laravel Blade, Tailwind CSS and bud.js and is available on the Roots website.

Requirements

Before running the Sage installation script, you must have the following:

Note: The script assumes a Mac OS X environment. If you are using a different operating system, you will need to install Sage manually, skip to How it Works to understand what the script is doing so you can recreate the process.

You will also need a copy of the site cloned to your local environment as the script will be run locally. You may use git clone or terminus local:clone site-name to clone the site.

Running the Script

If you have all the above requirements, including a copy of the site locally, cd into the root directory of the project and run:

composer install-sage

Running the Script in Headless Mode

The script can also be run with no user interaction at all. Instead of answering the prompts in the script itself, you can pass information via environment variables before running the script. The following environment variables are available:

  • SITENAME - The name of the site on Pantheon. This is the name that you would use to run Terminus commands like terminus site:info or terminus wp. This is not required if the script is being run from inside a site repo.
  • SFTPUSER - The SFTP username for the site. This is not required if the script is being run from inside a site repo. This is the SFTP username that you can get from the Pantheon dashboard.
  • SFTPHOST - The SFTP hostname for the site. This is not required if the script is being run from inside a site repo. This is the SFTP hostname that you can get from the Pantheon dashboard.
  • SAGENAME - The name of the theme that you want to create. This is required.
  • PHPVERSION - The PHP version that you want to use. This is optional and defaults to 8.0. 8.3 is a valid option but will be updated to 8.2 until PHP 8.3 is available on Pantheon.
  • SITEENV - The Pantheon environment that you want to use. This is optional and defaults to dev. This is the environment that you want to install the theme on. This can be dev or any valid multidev.
  • CI - Whether the script is being run from a Continuous Integration (CI) environment. When this exists, additional time is given to allow simultaneous workflows to run and the script will not attempt to open the site in a browser. This is optional and defaults to 0 (false). If you want to enable CI-mode, set this to 1. Setting the CI variable to 1 will also remove the confirmation prompts and prevent the script from restarting if no input is entered. Only use this if you are sure you have the correct information as the script will run autonomously with whatever data it is able to fetch from Terminus based on the current site repository.

Using environment variables

You can use any environment variables you want by simply exporting them in your shell or bash script before running the script. For example:

export SAGENAME="sage-theme"
export PHPVERSION="8.2"
export SITEENV="sage-1"
export SITENAME="my-site"
terminus multidev:create "$SITENAME".dev "$SITEENV"
git fetch --all
git checkout "$SITEENV"
composer install-sage

The above code will:

  • Set the Sage theme name to sage-theme
  • Set the PHP version to 8.2 in pantheon.yml
  • Create a multidev environment named sage-1
  • Check out the sage-1 branch
  • Run the Sage installation script on the sage-1 multidev environment

How it Works

The script does a lot of things and each step builds onto the last. You can look at the script in private/scripts/helpers.sh if you're interested in the precise commands that are being run. This overview will walk through each step.

Check Login

The first thing the script will do is check to see if you are logged into Terminus with a terminus whoami command. If you are not logged in, the script will end and you will be prompted to log in first.

Get Site Info

Once we know you are logged into Terminus, the script can run a terminus site:info command. From this, the script is able to extract the site name and ID and stores them in variables that we can use in the next step.

Prompt for Information

If the script was able to identify the site ID and Name, the only thing the script will prompt you for is the name of the theme that you want to create. If it was not able to identify that information, the prompt will ask for Site Name, SFTP username and hostname, and the theme name. Once this information is entered, a confirmation prompt is displayed to ensure that the information is correct. You can type y to accept the information or n to start the prompts over. If the defaults were used, they will be cleared on a n entry, but they will be displayed in their respective prompts.

It's important at this step, when choosing a theme name, to use a name that does not include spaces. This name will be used as the directory name and slug for the theme and will be used in bash commands which could error or fail if spaces were entered that it was not expecting.

Update PHP

The first change the script actually makes is updating the PHP version in the pantheon.upstream.yml file to 8.0 as required by Sage. This is done with a sed command and immediately pushed on completion.

php_version: 8.0

Install Sage

The next step is to install Sage. Before this is done, the script will check to see if a directory already exists in web/app/themes that matches the name of the theme you entered. If it does, the script will end immediately with a Directory not empty error. Otherwise, the script will continue by running the following composer commands:

# Create the new Sage theme
composer create-project roots/sage $sagedir

# Require Roots/acorn
composer require roots/acorn --working-dir=$sagedir

# Install all the Sage dependencies
composer install --no-dev --prefer-dist --working-dir=$sagedir

Note: In the code snippet above, $sagedir refers to the full path of the Sage theme that you are creating. If you are performing the steps manually, you can save that variable name by entering sagedir=web/app/themes/<your-theme-name> before running the commands.

Once the Composer processes are done, the NPM processes kick in, The script will run the following to build and install all the Sage NPM dependencies.

npm install --prefix $sagedir
npm run build --prefix $sagedir

When this completes, the .gitignore file inside the new Sage theme is modified to remove the line ignoring the /public/ directory, which should exist on the Pantheon environment.

Then, the newly created theme is added to Git and committed.

  git add $sagedir
  git commit -m "[Sage Install] Add the Sage theme ${sagename}."
  git push origin master

Adding the Symlink

The next part of the script adds a symlink to point web/app/cache to web/app/uploads/cache. Sage assumes the web/app/ directory is writeable, but on Pantheon it is not. However, we can get around this by creating a symbolic link so web/app/cache points to web/app/uploads/cache.

First, the script switches to the Pantheon site to SFTP mode, which we will need to make changes to the filesystem before creating the symlink.

  terminus connection:set $sitename.dev sftp

Then, it checks the existance of and creates the web/app/uploads and web/app/uploads/cache directories if they do not exist. Then, it connects to the site over SFTP to create the /files/cache directory with the following command:

sftp -P 2222 $sftpuser@$sftphost <<EOF
    cd /files
    mkdir cache
EOF

The script then switches back to Git mode so we can commit our symbolic link:

  terminus connection:set $sitename.dev git

Finally, the symlink is created and committed to Git:

  cd web/app
  ln -sfn uploads/cache
  git add .
  git commit -m "[Sage Install] Add symlink for /files/cache to /uploads/cache"
  git push origin master
  cd ../..

Update the composer.json File

The next step is to update the composer.json file to include a post-install-command to run composer install on Sage every time a composer install is run on the site. To do this, the script uses the jq command:

  jq -r '.scripts += { "post-install-cmd": [ "@composer install --no-dev --prefer-dist --ignore-platform-reqs --working-dir=%sagedir%" ] }' composer.json > composer.new.json
  sed -i '' "s,%sagedir%,$sagedir," composer.new.json
  rm composer.json
  mv composer.new.json composer.json

If you are doing this manually, you can add the following to your composer.json in the scripts section:

  "post-install-cmd": [
    "@composer install --no-dev --prefer-dist --ignore-platform-reqs --working-dir=web/app/themes/<your-theme-name>"
  ]

Once the change is made, it's committed and pushed to the site.

Final Steps

The last steps are to activate the theme and verify that it displays as expected.

For WordPress multisites, we need to first Network Enable the theme before it can be activated, so the script runs the following command:

  terminus wp $sitename.dev -- theme enable $sagename --network

Then, the theme is activated:

  terminus wp $sitename.dev -- theme activate $sagename

Finally, the script will open the site in your default browser to verify that the theme is displaying as expected.

terminus wp -- $sitename.dev theme enable $sagename

For single sites, this will produce an error, but it will not exit the script. This is normal and expected. Once we know that the theme is enabled (if applicable), the script will run a wp theme list to ensure it appears in the list of themes:

  terminus wp -- $sitename.dev theme list

If you are performing these steps manually, take time to make sure that your new theme shows up in the theme list. If it does not, you may want to retrace your steps.

Assuming it shows up, the next step is to activate the theme. This is also done via WP-CLI.

  terminus wp -- $sitename.dev theme activate $sagename

Once it's activated, the script will attempt to open your site in your default browser. If you are performing these steps manually, you can open the site in your browser and verify that the theme is displaying as expected. It's possible here that you may need to flush your browser cache or use a different browser if you did not see the new sage theme show up. If you continue to see a different default theme, ensure the theme is activated by going to your wp-admin/themes.php page. Otherwise, you should see something like this:

Newly-installed Sage theme screenshot

If you see a fresh Sage starter theme, the setup worked and you're ready to start building! Refer to the Sage documentation for more information on how to use Sage now that it's been installed.

Final Thoughts

This script was written with the assumption that you are only using a single Sage theme. If you install multiple Sage themes, you will need to manually update the composer.json file to include the post-install-cmd for each theme as the script will update the existing entry if one exists already. Additionally, some steps (like creating directories and symlinks) will naturally fail if those things have been done already.