The Drupal 9 sites that the WaTech Team has on Pantheon are non-integrated composer sites. By non-integrated, this means that they are not connected with the Pantheon dashboard. As such, the WWS (WaTech Web Services Team) use Ubuntu and Composer to update their Drupal 9 sites. In addition to Composer, they use a really cool tool called Ahoy which enables them to custom create commands using Composer, Terminus, Git, etc. The Ahoy file that defines all these functions is kept on Github and you set up Ahoy in your Ubuntu.
This procedure will take you through updating the website through DEV. From there, email Sam and let him know that the site is updated and waiting in DEV. He will then push it to LIVE from there.
Developers to Sites
The following developers "own" the following sites. When we go to develop they are responsible for updating these sites.
- wdva intranet
- wdva intranet
Guide to Updating the Sites
Cloning the Site's Code to your Machine
Step 1. YOU ONLY NEED TO DO THIS ONCE. Clone the website files from the master repository to your local machine's repository. In Ubuntu, in your WaTech/Website folder, enter the git clone command from the Pantheon dashboard to pull site locally, if you don't already have it. You should only have to do this once per site. In your Pantheon dashboard go to DEV tab and click the "Code" tab on the left navigation. Make sure the site is set to "Git" and then click the drop down "Clone with Git". Click the "Copy" button. In Ubuntu, makes sure you are in the watech/websites folder as you see in the example below. Then right click your mouse in the command line and your git clone command will be pasted into that line. Then press "Enter" and you will clone all of the files from the master repository to your local repository.
Prepare the Site and Yourself
The purpose of this phase is to get the website and all its environments ready to update. It means pushing any of the pending commits to the website, backing the DEV environment up, reviewing the modules to update, and pulling the code back to your local repository.
Step 1. Set the site to "Git" and commit pending changes on DEV. If it is in SFTP and there are changes waiting to be committed talk to Sam to make sure it is ok to proceed.
Step 2. Check on the "Drupal Updates" excel spreadsheet before you proceed with this step. If the site you are updating is color coded in orange and says "dev only" DO NOT pull down the LIVE database to DEV and just skip this step. If it is clear to do so, go to the DEV tab and then on the left nav click on "Database/Files". Then select the drop down and change TEST to LIVE and check "Run update.php" and "clear cache". The click "Clone Database and files from LIVE to DEV".
Step 3. Backup DEV. On the Pantheon dashboard go to the DEV tab and click the "Backups" in the left nav. Then click "Create New Backup" button.
Step 4. In Ubuntu go to the website's folder you want to update. If you are already in your watech/websites folder, enter the command "cd <name of website>" (enter the name of the website you want to enter between the <>). If you do not know the name of the website enter in your Ubuntu command line "ls" and it will list out all the folders/websites in your websites folder. Once in the specific website folder you want, enter the command "git pull" to make sure your local repository is current. You should always do this prior to working on your local repository code.
Step 5. Go to DEV website and visually review to see how they are functioning and appearing prior to updating.
Step 6. Sign into the DEV environment and check and see what modules need to be updated. This is for your general awareness when you go to update the site. Once in the site, to see the modules that need to be update go to admin>Extend>Update and you will see a list of modules that need to be updated and if core needs to be updated.
Step 7. Review admin>reports> available updates to see what modules need to be updated.
Step 8. Review admin>reports>recent log messages to see what the current errors are on the site.
Step 9. Review admin>reports>status report to see the status of the site and if there are currently any major issues being reported.
Update the Site
In this phase you will use Ahoy commands in Ubuntu to execute Composer commands to update the modules in this site on your local machine/repository. Composer will go out to each module's "website" and pull the latest version of the module and dependencies. If all goes well, you will get an "Exit: 0" and the local version of the site on your machine is now up-to-date. If it does not go well, in your Ubuntu you will see the error or errors and it will explain what went wrong. There is a real skill in reading the errors and troubleshooting those errors. All of the following commands are run in your Ubuntu and in the websites' folder.
Step 1. Enter the command "ahoy total-update". If there are errors you may have to troubleshoot and repeat the command once the errors are fixed.
Step 2. Enter the command "ahoy status". Review and address as appropriate any modules that still show needing to be updated.
Step 2.1 Review list of modules against the "Do not update list".
Link to the official "Do Not Update" list in teams.
|Module||Stick with version||Notes on updating|
|blazey||2.10||2.12 will crash the live side of the site. Admin will be fine.|
|fullcalandar_view||^2||Upgrading to ^5 can cause the calendar to disappear|
|path_redirect_import||1.0@beta||When you upgrade to v2 it crashes the site because it is looking for a dependency|
|media_pdf_thumbnail||^3||Upgrading to ^5 causes an error|
|protected submissions||discontinued||Need to replace this module with its successor "Protected Forms". It has all the same settings, so the process would be to 1) install Protected Forms, 2) copy the settings over from Protected Submissions to Protected Forms, then 3) uninstall Protected Submissions. (inform Sam and let us do this together the first few times)|
Ahoy status will give you a screen that looks like this. It first gives you the name of the module that still needs to be updated. In this case it is anchor_link. Just a note, this name is the machine name of the module. This is the name that Drupal knows it as. If you go on the internet and look for it, it is called Anchor Link. The current version number in white is next which in this case is 1.9.0. The available version number is in orange and it is 2.5.0. The difference in the first numbers of a "1" and "2" means that it is a major version change. Two make a major version change you have to go into the composer file and make that change. In the example below all of the changes are major version changes. We will address major version changes in a little bit. So, now you need to compare this list with the "Do not update" list. There are certain modules that are purposely kept at their existing version because the current/updated version is not compatible with our website. These modules that are on the "Do not update" need to remain at their existing version as shown in the ahoy status and the composer.json file. The others should be updated which is in the next step.
Step 2.2. DO NOT do this with anchor_link as this is on the Do Not Update list. This is an example of what you would do if it was not on that list and ok to update. Go to your Sublime and open the website's composer.json file as shown in the screen shot below. Within the "require" section of the composer.json file find the module using the machine name shown by ahoy status. In this case the composer.json file says that anchor_link can be anything equal to or higher than 1.7, but not 2.0 or higher. The "^" (carrot) locks it to version 1.something. The carrot makes you approved it going to the next major version with is 2.0. So to allow it to update to the most current version change it in the composer.json file to "^2.0". Make that adjustment for all of the modules on the list approved to upgrade. Save the composer.json file.
Step 2.3. Enter "ahoy total-update" again and you will see in your Ubuntu that module being updated and any other modules you updated in the composer.json file.
Step 2.4. Enter "ahoy status" again and repeat the process until there are no more modules you should or can update.
Step 3. Enter the command 'ahoy sendup "enter your updating comments here" '. This command will ("git add .", "git commit -m", and "git push") push and merge your local changes to the main to the main repository. Once you have entered this command in Ubuntu go to the Pantheon dashboard and wait for Pantheon Dashboard workflow to finish.
Step 4. Enter the command "ahoy dbcc dev" to clear cache and update the database on the DEV environment. This is important because it integrates your code changes with the dev database. For example, the database keeps track of modules like the code does. This aligns the code and the database.
Step 5. Test DEV. Check the DEV Admin >> Reports >> Status reports for errors and Admin>>reports>>recent log messages . Also visually look around the site and see if anything is acting odd.
Step 6. Update the WaTech Drupal Site Update. Place "date, dev, your initials" in the upgrade cell. Notify Sam the site is updated and pushed to DEV and whether or not there are issues.
Once you have done multiple updates you can shift to these steps which lack description and context.
Step 1. Commit pending changes on DEV as appropriate.
Step 2. Pull database and files back from LIVE to DEV.
Step 3. Backup DEV
Step 4. Review DEV for updates and errors
Step 5. GIT Pull local to make sure your local is current
Step 6. Run ahoy total-update
Step 7. Run ahoy status.
Step 8. Review outdated modules against the "Do Not Update" list and update modules as appropriate.
Step 9. Run ahoy sendup "<module update comments>"
Step 10. (wait for Pantheon Dashboard workflow to finish) run ahoy dbcc <env>
Step 11. Test DEV. Check the DEV Admin >> Reports >> Status reports for errors.
Step 12. Update the WaTech Drupal Site Update. Place "date, dev, your initials" in the upgrade cell. Notify Sam the site is updated and pushed to DEV and whether or not there are issues.