Skip to content

Explain generated files and Drupal settings in workspaces #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csandanov merged 1 commit into from
Sep 28, 2026
Merged

Explain generated files and Drupal settings in workspaces #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 10 additions & 3 deletions 2.0/docs/apps/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ The page also shows the checkout's live **Git status**: the current branch and w
and the uncommitted changes. Select **Refresh** to read it again. Only the workspace owner sees it. The initial branch
and commit on the page record the state at creation.

Files the service generates, such as installed dependencies or Drupal core and contrib modules, stay out of Git status.
Setup lists them in the checkout's `.git/info/exclude`, which Git never commits, so your `.gitignore` doesn't change.
Your own lines in that file are kept, and **Retry setup** updates Wodby's list. Custom code, such as Drupal's custom
modules and themes, still shows up, and so do changes to tracked files.

### Storage

Wodby keeps the code checkout and agent home on volumes of the cluster's default storage class, and runs the code
Expand Down Expand Up @@ -178,9 +183,11 @@ Workspace setup is separate from ordinary post-deployment scripts. Those scripts
After pulling code yourself, decide whether to rerun setup, run an application-specific command, or restart the
application.

For Drupal projects with a tracked settings file, include the required Wodby settings bootstrap intentionally in your
project. Setup will not rewrite tracked settings or replace tracked upload placeholders. Making a tracked file
ignored does not remove it from Git.
In Drupal projects, setup creates `settings.php` from `default.settings.php` when it's missing, or adds Wodby's
settings include to your existing file. The include loads only when Wodby's settings file exists, so you can commit it
and the file keeps working elsewhere. A tracked `settings.php` shows the include as a change to commit. Setup stops
rather than replace a tracked `files` directory with the link to uploaded files. Remove the directory from Git, make
sure Git ignores it, and retry setup. Ignoring a tracked file doesn't remove it from Git.

## Deliver changes to a CI/CD environment

Expand Down
Loading