Data source and site addresses

data.from is source to copy the database of the checkout this worktree is created from, or none to start empty. data.needs names unversioned files or directories that must travel with that data. data.addresses names files in which copied DDEV URLs may be pointed at the new worktree.

Every worktree answers at an address of its own, and a site has to know it. Where the data comes from the project checkout — which is every worktree, since one is built with the project's own data — the site configuration that reads that data comes with it, and Branchery points the addresses in it at this worktree: every https://….ddev.site in config/sites and typo3conf/sites is rewritten to https://<worktree>.<project>.ddev.site/. The settings file comes along with it where the worktree has none of its own — an application that has never been set up has no settings.php, boots as an installer, and runs every console command without the container it needs.

Only where the branch does not have that configuration under version control. A committed config/sites/main/config.yaml is the project's file: writing a developer's worktree address into it leaves every worktree standing in the list with an uncommitted change, and the one change in it is the one that must never be pushed. So nothing is written into it, and the operation says in its log which address the worktree answers at instead.

A project that commits its site configuration says where its address comes from, and has three ways to do it. Branchery hands the address over in the environment of the worktree — in additional.php, which is loaded before any site is read, and to every command an operation runs:

BRANCHERY_HOST

my-fix.blog.ddev.site — what a site is found by

BRANCHERY_URL

https://my-fix.blog.ddev.site/

BRANCHERY_NAME

my-fix

BRANCHERY_BRANCH

the branch the worktree was made for (commands only)

BRANCHERY_DATABASE

branchery_my_fix (commands only)

A relative base. The shortest answer, and the one that needs nothing from Branchery: a site whose base is / is served at whatever address reaches it.

base: /

The address out of the environment. TYPO3 resolves %env(…)% in config.yaml against the environment, so the site asks for the host it is being served at:

base: 'https://%env(BRANCHERY_HOST)%/'

The project checkout itself is not a worktree and has no such variable, so it says its own once, where DDEV keeps the environment of the web container:

web_environment:
  - BRANCHERY_HOST=blog.ddev.site

That is the whole of the setup. Every worktree is then right at its own address without a file being touched, and git status in a fresh worktree is empty. The placeholder is resolved when the configuration is read and cached with it -- which is no trouble here, because every operation ends with finish.

A step of the project's own. Where neither fits — a base that is stored somewhere else, a second site that has to be renamed, an address in a fixture -- this file is the place: migrate.after runs after the data has arrived, with the whole environment above in it.

migrate:
  after:
    - ./bin/point-the-sites-at "$BRANCHERY_URL"