Merge pull request #114 from itk-dev/feature/drupal-site-update

Added more info on "Check that site can be updated" job"

Author: rimi-itk

github/workflows/drupal/site.yaml

@@ -64,6 +64,28 @@ jobs:
     # Check updating site only on pull request.
     if: github.event_name == 'pull_request'
     name: Check that site can be updated
+
+    # This job checks that the Drupal site can be upgraded without issues.
+    #
+    # We do this by
+    #
+    # 1. Checking out the base branch ("github.base_ref") and installing the
+    #    site from scratch (using the exact same steps as the "install-site"
+    #    job)
+    # 2. Checking out the updated code and updating the site from the previous
+    #    installation
+    #
+    # Notice that step 2 is NOT run with the code in our new branch, but with
+    # the updated code merged on top of the target branch
+    # (cf.https://github.com/actions/checkout/issues/881). This makes sure that
+    # we can actually update the site after merging with the base branch.
+    #
+    # In some cases we run into a situation where the base site (step 1) cannot
+    # be installed, e.g. if this is a new project or we're making changes that
+    # require manual steps on the upgrade path, and then this jobs will fail. In
+    # that case we should note this in the pull request description and document
+    # the steps needed to complete the upgrade path.
+
     runs-on: ubuntu-latest
     steps:
       # Install site from our base ref
@@ -101,17 +123,15 @@ jobs:
           sudo chown -Rv $USER:$USER vendor/ web/ private-files/ || true
           sudo chmod -Rv a+w web/sites/default || true
 
-      # Install site with our current ref
+      # Update site using our updated code.
       - uses: actions/checkout@v4
         with:
-          ref: ${{ github.head_ref }}
           # Keep our local settings (cf.
           # https://github.com/actions/checkout?tab=readme-ov-file#usage)
           clean: false
 
       - name: Start docker and install dependencies
         run: |
-          docker network create frontend || true
           docker compose pull
           docker compose up --detach