Killer Drupal 8 Workflow for Pantheon
This project is meant to be forked and used as an easy-to-get-going start state for an awesome dev workflow that includes:
- Canonical upstream repo on GitHub
- Local development and tooling with Lando
- Hosting on Pantheon
- Automatic manual QA environments via Pantheon multi-dev
- Merge-to-master deploy-to-pantheon-dev pipeline
- Automated code linting, unit testing and behat testing with Travis
What You'll Need
Before you kick off you'll need to make sure you have a few things:
- A GitHub account, ideally with your SSH key(s) added
- A Pantheon account with a Machine Token
- A Travis CI account
- Lando installed
- Git installed*
- (Optional) ZenHub for Kanban style issue management in GitHub
It is also definitely worth reading about the upstream starter kit.
- If you are using lando you can forgo the git installation (this is potentially useful for Windows devs) by uncommenting git in the tooling section of your .lando.yml. If you do this you'll need to run
lando gitinstead of
gitfor all the examples below.
1. Setup Pantheon
Login to Pantheon and create a new D8 project through the user interface. After naming your site and completing the spin up visit your site and go through the Drupal installation process to get your DB dialed in.
2. Setup GitHub
Visit this start state on GitHub and fork the project to the org or account of your choosing. Then
git clone the repo and
cd into it.
git clone https://github.com/lando/lando-pantheon-ci-workflow-example mysite cd mysite
3. Setup Local Lando and Connect to Pantheon
Let's start by spinning up a local copy of our Pantheon site with Lando.
This should spin up the services to run your app (eg
varnish) and the tools you need to start development (eg
drupal console). This will install a bunch of deps the first time you run it but when it is done you should end up with some URLs you can use to visit your local site.
# Connect to pantheon cd /path/to/my/repo lando init --recipe=pantheon # Start the app lando start # Pull the database and files # Run lando pull -- -h for options land pull
If you are interested in tweaking your setup check out the comments in your app's
.lando.yml. Or you can augment your Lando spin up with additional services or tools by checking out the advanced Lando docs.
4. Setup Travis CI
You will want to start by doing Steps 1 and 2 in the Travis getting started docs. We already have a pre-baked
.travis.yml file for you so you don't need to worry about that unless you want to tweak it.
Finally, set your Pantheon machine token and site machine name as environment variables via the Travis UI.
Trying Things Out
Let's go through a GitHub flow example!
This is a trivial example which deploys all merges into the
master branch to the Pantheon dev environment.
1. Set up a topic branch
# Go into the repo cd /path/to/my/github/repo # Checkout master and get the latest and greatest git checkout master git pull origin master # Spin up a well named topic branch eg ISSUE_NUMBER-DESCRIPTION git checkout -b 1-fixes-that-thing
2. Do the dev, commit and push the codes
# Do some awesome dev # Git commit with a message that matches the issue number git add -A git commit -m "#1: Describes what i did" # Push the branch to GitHub git push origin 1-fixes-that-thing
- Check out the Lando Reference section below for some tips on how to run tests before you push. This can save a lot of time and reduce the potential shame you feel for failing the automated QA
3. Open a PR and do manual and automated testing
Begin by opening a pull request. This will trigger the spin up of a QA environment for manual testing and a Travis build for automated testing.
Here is an example PR with:
When you are statisifed with the above, and any additional QA steps like manual code review you can merge the pull request. This will deploy the feature to production.
You should definitely check out the Lando Pantheon docs for a full sweep on its capabilities but here are some helpers for this particular config. YOU PROBABLY WANT TO LANDO START YOUR APP BEFORE YOU DO MOST OF THESE THINGS.
Unless otherwise indicated these should all be run from your repo root (eg the directory that contains the
.lando.yml for your site).
# List all available lando commands for this app lando # Start my site lando start # Stop my site lando stop # Restart my site lando restart # Get important connection info lando info # Other helpful things # Rebuild all containers and build process steps lando rebuild # Destroy the containers and tools for this app lando destroy # Get info on lando service logs lando logs # Get a publically accessible URL. Run lando info to get the proper localhost address lando share -u http://localhost:32813 # "SSH" into the appserver lando ssh # Run help to get more info lando ssh -- --help
# Run composer things lando composer install lando composer update # Run php things lando php -v lando php -i # Run drush commands # replace web if you've moved your webroot to a difference subdirectory cd web lando drush status lando drush cr # Run drupal console commands # replace web if you've moved your webroot to a difference subdirectory cd web lando drupal
# Lint code lando phplint # Run phpcs commands lando phpcs # Check drupal code standards lando phpcs --config-set installed_paths /app/vendor/drupal/coder/coder_sniffer lando phpcs -n --report=full --standard=Drupal --ignore=*.tpl.php --extensions=install,module,php,inc web/modules web/themes web/profiles # Run phpunit commands # replace web if you've moved your webroot to a difference subdirectory cd web lando phpunit # Run some phpunit tests lando phpunit -c core --testsuite unit --exclude-group Composer # Run behat commands lando behat # Run some behat tests lando behat --config=/app/tests/behat-pantheon.yml
# List terminus commands lando terminus list # Pull stuff from pantheon # NOT THE BEST IDEA IN THIS SETUP lando pull # Push stuff to pantheon # NOT THE BEST IDEA IN THIS SETUP lando push # Switch multidev env # NOT THE BEST IDEA IN THIS SETUP lando switch <ENV> # Advanced commands # Redis CLI lando redis-cli # Varnish admin lando varnishadm