---
title: "Update and uninstall"
description: "The application is an image, and a project installs a tag of it."
canonical: update.html
navigation-title: "Update and uninstall"
---

<a id="update"></a>

- [Update](#update-1)
- [Being told there is one](#being-told-there-is-one)
- [Choose another image](#choose-another-image)
- [Uninstall](#uninstall-1)

<a id="update-and-uninstall"></a>

# Update and uninstall

The application is an image, and a project installs a tag of it. An update
fetches the next tag; an uninstall takes the add-on out and leaves the
worktrees standing.

<a id="update-image"></a>

<a id="update-1"></a>

## Update

An update is the add-on fetched again and the project restarted:

```bash
ddev add-on get benjaminkott/ddev-branchery
ddev restart
```

`.ddev/docker-compose.branchery.yaml` names the image tag installed in the
project. The update writes the new tag, and the restart replaces the running
container; until then the old image continues to serve the application. The
running application notices when the project has been updated past it and says
so at the top of the page. A page left open fetches itself again as soon as the
new container answers, so what is on screen is never the interface of a version
that is gone.

An update also replaces the installed files, and a file a release stops
shipping is taken away with it. Read `git status` afterwards and commit what
changed, the removals included; the worktrees and their state under
`.ddev/branchery/var/` are never touched.

<a id="update-notice"></a>

<a id="being-told-there-is-one"></a>

## Being told there is one

A project cannot see from its own files that a newer version exists, so the
container asks once as it starts: what it finds is kept under
`.ddev/branchery/var/` and read from there. When the release is newer than the
tag the project asks for, the page says so at the top and offers the two
commands above as one line to copy. Both notices are about the whole
installation and they mean different things -- one is fixed by a restart, the
other by fetching the add-on again.

The answer is taken as current for six hours, so restarting a project repeatedly
does not ask again. Nothing depends on the request succeeding: with no network,
or once the hourly limit for unauthenticated requests to GitHub is reached, the
last answer stands and the start is not held up either way.

<a id="architecture-image"></a>

<a id="choose-another-image"></a>

## Choose another image

A different image can be selected without editing the generated compose file:

```bash
ddev dotenv set .ddev/.env.branchery --branchery-docker-image=ghcr.io/benjaminkott/ddev-branchery:v0.1.0
ddev restart
```

Delete `.ddev/.env.branchery` to return to the tag the add-on installed.
During development, `tools/deploy.sh <project>` builds the working copy and
selects that local image for the target project.

<a id="uninstall"></a>

<a id="uninstall-1"></a>

## Uninstall

```bash
ddev add-on remove branchery
ddev restart
```

The worktrees and their databases are kept on purpose, so an uninstall can be
undone by installing again. What is no longer wanted is removed by hand: the
checkouts under `.worktrees/` with `git worktree remove`, and the databases
with `ddev branchery database:prune --drop` before the add-on goes, or with
`ddev mysql` afterwards.