Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/drupal-integration-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,16 @@ jobs:
fi
echo "OK: anonymous request redirected to Coder login (site is private by default)"

- &dump-setup
# The checks above only report an exit code; the cause is in the
# workspace's setup log, which is gone once the workspace is deleted.
name: Dump setup status
if: failure()
run: |
coder ssh ${{ env.WORKSPACE_NAME }} -- cat /home/coder/SETUP_STATUS.txt || true
echo "--- last 60 lines of setup log ---"
coder ssh ${{ env.WORKSPACE_NAME }} -- tail -60 /tmp/drupal-setup.log || true

- &delete-workspace
name: Delete workspace
if: always()
Expand Down Expand Up @@ -389,6 +399,7 @@ jobs:
fi
echo "OK: anonymous request reached the public Drupal site (drupal_site_public=true works)"

- *dump-setup
- *delete-workspace

- name: Release staging box lock
Expand Down Expand Up @@ -576,6 +587,7 @@ jobs:
fi
echo "OK: anonymous request redirected to Coder login (site is private by default)"

- *dump-setup
- name: Delete workspace
if: always()
run: coder delete ${{ env.WORKSPACE_NAME }} --yes || true
Expand Down Expand Up @@ -778,6 +790,7 @@ jobs:
fi
echo "OK: anonymous request redirected to Coder login (site is private by default)"

- *dump-setup
- name: Delete workspace
if: always()
run: coder delete ${{ env.WORKSPACE_NAME }} --yes || true
Expand Down
13 changes: 6 additions & 7 deletions docs/content/self-hosting/server-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -880,10 +880,9 @@ This deploys three templates:
The `drupal-core` template can provision workspaces faster using a **seed cache** on the host. The cache is a **bare** git clone of drupal/drupal. When a workspace starts, the startup script:

1. Creates a fresh git repo in the workspace directory
2. Adds the bare cache as a local remote and fetches from it (fast — reuses local objects, no network)
3. Removes the cache remote
4. Fetches from `git.drupalcode.org` for any commits newer than the cache
5. Checks out `main` (or the issue branch)
2. Fetches the bare cache's branches and tags as `origin`'s (fast — reuses local objects, no network)
3. Fetches from `git.drupalcode.org` for any commits newer than the cache
4. Checks out `main` (or the issue branch), from the cache's refs if `git.drupalcode.org` can't be reached

This avoids downloading hundreds of MB per workspace and eliminates working-tree issues that a non-bare cache causes.

Expand All @@ -897,7 +896,7 @@ The seed directory IS the bare clone root — no subdirectory nesting. No workin

### Install the hourly update timer

The update script runs `git fetch --all --prune` to keep the bare cache current. Because there is no working tree, no `git merge` is needed. Install it as an hourly systemd timer:
The update script fetches every branch and tag into the bare cache to keep it current. Because there is no working tree, no `git merge` is needed. Install it as an hourly systemd timer:

```bash
REPO=~/workspace/coder-ddev # adjust if your repo is elsewhere
Expand Down Expand Up @@ -1023,10 +1022,10 @@ The `update-drupal-cache` script handles both bare and non-bare repos automatica
**Update script fails:**

```bash
git -C ~/cache/drupal-core-seed fetch --all --prune
git -C ~/cache/drupal-core-seed fetch --prune origin '+refs/heads/*:refs/heads/*' '+refs/tags/*:refs/tags/*'
# If this fails, check network connectivity or re-clone:
rm -rf ~/cache/drupal-core-seed
git clone https://git.drupalcode.org/project/drupal.git ~/cache/drupal-core-seed
git clone --bare https://git.drupalcode.org/project/drupal.git ~/cache/drupal-core-seed
```

---
Expand Down
13 changes: 11 additions & 2 deletions drupal-core/scripts/update-drupal-cache
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
# the real remote, avoiding several hundred MB of network transfer per workspace.
#
# Using a bare repo is intentional: there is no working tree to keep in sync and
# no "Your branch is behind" noise. git fetch --all --prune is all that is needed.
# no "Your branch is behind" noise. Branches and tags are fetched straight into
# refs/heads and refs/tags (a bare clone has no fetch refspec of its own).
#
# Initial setup (one-time, run as the seed-directory owner):
# git clone --bare https://git.drupalcode.org/project/drupal.git ~/cache/drupal-core-seed
Expand Down Expand Up @@ -70,7 +71,15 @@ echo "Started: $(date)"
echo ""

echo "Fetching Drupal core git objects..."
git -C "$SEED_DIR" fetch --all --prune
if [ "$IS_BARE" = "true" ]; then
# `git clone --bare` configures no fetch refspec, so a plain
# `git fetch --all` only writes FETCH_HEAD and leaves every branch where
# the initial clone put it. Fetch branches and tags into place explicitly.
git -C "$SEED_DIR" fetch --prune origin \
'+refs/heads/*:refs/heads/*' '+refs/tags/*:refs/tags/*'
else
git -C "$SEED_DIR" fetch --all --prune
fi

if [ "$IS_BARE" = "false" ]; then
echo "Fast-forwarding local main branch..."
Expand Down
41 changes: 28 additions & 13 deletions drupal-core/template.tf
Original file line number Diff line number Diff line change
Expand Up @@ -552,27 +552,36 @@ STATUS_HEADER
_t=$SECONDS
DRUPAL_REMOTE="https://git.drupalcode.org/project/drupal.git"
if git -C "$CACHE_SEED" rev-parse --is-bare-repository 2>/dev/null | grep -q true; then
# Bare cache: init repo, add all remotes (cache, origin, issue fork if
# applicable), fetch cache first (fast local copy of all objects), then
# fetch origin and issue fork for only the delta.
# Bare cache: init repo, add origin (and the issue fork if applicable),
# copy the cache's branches and tags in as origin's refs (fast local
# copy of all objects), then fetch origin and issue fork for only the
# delta.
log_setup "Initialising Drupal core repo (bare cache + origin delta)..."
mkdir -p "$DRUPAL_DIR"
git -C "$DRUPAL_DIR" init -q >> "$SETUP_LOG" 2>&1
git -C "$DRUPAL_DIR" remote add drupalcache "$CACHE_SEED"
git -C "$DRUPAL_DIR" remote add origin "$DRUPAL_REMOTE"
if [ "$USING_ISSUE_FORK" = "true" ] && [ -n "$ISSUE_FORK" ]; then
# --no-tags: the fork's tags duplicate core's ~800 tags from origin.
git -C "$DRUPAL_DIR" remote add --no-tags issue "https://git.drupalcode.org/issue/drupal-$${ISSUE_FORK}.git"
fi
# Fetches use -q so the log isn't flooded with one line per branch/tag
# (core has ~800 refs); errors still go to stderr and land in the log.
#
# The cache's refs land directly under refs/remotes/origin/*, not under
# a separate cache remote. That matters twice:
# - The origin fetch below can only skip objects that local refs point
# to. Refs under a temporary remote vanish with `git remote remove`,
# which left nothing to negotiate with, so every workspace downloaded
# all of core's history again (3-10 minutes, and sometimes failed).
# - When the origin fetch fails, origin/main and the version branches
# still exist from the cache, so the checkout below works.
_f=$SECONDS
git -C "$DRUPAL_DIR" fetch -q drupalcache >> "$SETUP_LOG" 2>&1
log_setup " Fetched local cache ($((SECONDS - _f))s)"
# Remove the local cache remote now — objects are in the local repo and
# keeping it causes ambiguous-ref errors when checking out branches that
# exist in both drupalcache and origin.
git -C "$DRUPAL_DIR" remote remove drupalcache
if git -C "$DRUPAL_DIR" fetch -q --no-tags "$CACHE_SEED" \
'+refs/heads/*:refs/remotes/origin/*' '+refs/tags/*:refs/tags/*' >> "$SETUP_LOG" 2>&1; then
log_setup " Fetched local cache ($((SECONDS - _f))s)"
else
log_setup " ⚠ Fetch from local cache failed — fetching everything from origin"
fi
_f=$SECONDS
if git -C "$DRUPAL_DIR" fetch -q origin >> "$SETUP_LOG" 2>&1; then
log_setup " Fetched origin ($((SECONDS - _f))s)"
Expand All @@ -587,7 +596,13 @@ STATUS_HEADER
log_setup " ⚠ Fetch from issue fork failed"
fi
fi
git -C "$DRUPAL_DIR" checkout -b main --track origin/main >> "$SETUP_LOG" 2>&1
if ! git -C "$DRUPAL_DIR" checkout -b main --track origin/main >> "$SETUP_LOG" 2>&1; then
# Without this, a failed checkout left an empty working tree that
# setup reported as cloned, and the failure only surfaced later as
# "Failed to install Drupal".
log_setup "✗ Failed to check out main (no origin/main from cache or origin)"
SETUP_FAILED=true
fi
elif [ -d "$CACHE_SEED/.git" ]; then
# Non-bare (legacy) cache: use as --reference hint to avoid re-downloading
# objects that already exist locally.
Expand All @@ -598,11 +613,11 @@ STATUS_HEADER
log_setup "Cloning Drupal core..."
git clone -q "$DRUPAL_REMOTE" "$DRUPAL_DIR" >> "$SETUP_LOG" 2>&1
fi
if [ -d "$DRUPAL_DIR/.git" ]; then
if [ "$SETUP_FAILED" != "true" ] && [ -d "$DRUPAL_DIR/.git" ]; then
log_setup "✓ Drupal core cloned ($((SECONDS - _t))s)"
update_status "✓ Git clone: Success"
else
log_setup "✗ Failed to clone Drupal core"
[ -d "$DRUPAL_DIR/.git" ] || log_setup "✗ Failed to clone Drupal core"
update_status "✗ Git clone: Failed"
SETUP_FAILED=true
fi
Expand Down
Loading