---
title: "Renovate | Preflight docs"
description: "Preflight owns the stack's version automation: the shared preset and the component that runs it."
url: https://preflight.apps.wayne.edu/docs/guides/renovate.html
llms: https://preflight.apps.wayne.edu/llms.txt
generator: Squire agent-ready
---

# Renovate: what merges and what waits [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#renovate-what-merges-and-what-waits)

This page covers what Preflight's version automation auto-merges, what waits for a person, and how the private runner project is set up. For the component's inputs, go to [the `renovate` component](https://preflight.apps.wayne.edu/docs/guides/component-renovate.html).

## How it works [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#how-it-works)

Preflight owns the stack's version automation (ADR-0015): the shared preset `renovate/default.json` and the [`renovate` component](https://preflight.apps.wayne.edu/docs/guides/component-renovate.html) that runs it. A private runner project includes the component on a schedule; Renovate discovers every repository in the filter, opens merge requests for outdated versions, and GitLab's native auto-merge takes in the ones whose pipeline is green.

Every stack repository carries a `renovate.json` that extends the shared preset, so the rules change in one place:

```json
{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["local>enterprise-apps/preflight//renovate/default"]
}
```

## What auto-merges [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#what-auto-merges)

Digest updates, pin and pinDigest updates, and patch and minor version bumps auto-merge when the pipeline is green. Lock file maintenance runs weekly and auto-merges the same way. Every merge request carries the `auto-deps` label.

The exception is Preflight's own pins: an update that touches the templates, the contract or this repository's own pipeline, a bump of a component include version, and a bump of the recorded Squire kit version, never auto-merge (see [What waits for review](https://preflight.apps.wayne.edu/docs/guides/renovate.html#what-waits-for-review)).

## What waits [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#what-waits)

Major version bumps never auto-merge. The merge request carries the `major` label and waits for a person.

## What waits for review [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#what-waits-for-review)

Updates that change an image digest inside the templates, the contract, or this repository's own pipeline, bumps of a Preflight component version in an app's `component:` include, and bumps of the recorded Squire kit version (labeled `squire-kit`) carry the `needs-review` label and never auto-merge. They wait for a person because those pins are what every app pipeline runs: a changed digest here changes what every consuming pipeline executes, so it earns a human eye even when its own pipeline is green. The Squire kit version bump also changes the kit's files; see [Squire kits](https://preflight.apps.wayne.edu/docs/guides/renovate.html#squire-kits).

## Squire kits [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#squire-kits)

A Squire deploy kit (the `deploy` folder in the stack's repos) is files Squire wrote, recorded with their hashes in `deploy/.squire.json`. Two rules in the preset keep it equal to a Squire release:

- **A new Squire refreshes the kit.** The custom manager reads the version in `.squire.json` and opens a merge request for each new `waynestate/squire` on Packagist. Its `postUpgradeTasks` install that release into a folder under `/tmp` (outside the repository, `--no-dev --no-scripts`) and run `squire update` on the kit folder, so the merge request carries the refreshed files. It waits for review (`squire-kit`, `needs-review`).
- **Renovate leaves kit files alone.** Updates to `docker-compose.squire.yml` and anything under `.squire/` are turned off outside Squire's own `templates/` folders. A digest or tag bump there is an edit to a file Squire owns: the kit drifts from its release, and the next `squire update` refuses to overwrite it. Change the image in Squire's templates instead; the next Squire release carries it to every kit.

Renovate only runs a post-upgrade command its runner allows. The [`renovate` component](https://preflight.apps.wayne.edu/docs/guides/component-renovate.html)'s `squire_kit_tasks` input (default `false`) writes the allow-list into the runner's `config.js`: two anchored patterns that match the exact `composer create-project` and `squire update` commands, with the version and paths limited to safe characters. No shell runs the commands. Without the input, the merge request bumps the version only and shows an artifact error; refresh it by hand with `vendor/bin/squire update --path=deploy`, review the diff and commit it to the branch.

A Squire release that adds a kit file needs `vendor/bin/squire init --path=deploy` as well: `squire update` refreshes the files the kit already lists and does not write new ones. The [`squire-kit` component](https://preflight.apps.wayne.edu/docs/guides/component-squire-kit.html) catches both cases, and any hand edit, by running `squire init --check` in the pipeline.

## Why MySQL and HA-Proxy get digests only [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#why-mysql-and-ha-proxy-get-digests-only)

The `mysql` and `haproxy` images mirror the versions Citadel actually runs, not the newest releases in the world. Bumping their tags would drift the apps away from production, so only digest updates are enabled for them: the same tag, the exact image. `citadel/php-apache` is disabled entirely, because Squire's own data owns that image.

## Pinned to immutable tags [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#pinned-to-immutable-tags)

The `quay.io/buildah/stable` image (the `image` default of the portability component) is matched to `-immutable` tags only. Red Hat re-pushed v1.43.5 under the mutable tag and garbage-collected the old digest, which broke an image job, so Drawbridge and Squire now pin the immutable form, `v1.43.5-immutable@sha256:...`. The preset carries a packageRule for `quay.io/buildah/stable` with a regex versioning that only matches `vX.Y.Z-immutable` tags, so Renovate proposes updates within the immutable tags and never moves a pin back to a mutable one. Digests stay pinned as before (`docker:pinDigests`).

## Set up (the user does this) [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#set-up-the-user-does-this)

This repository ships the preset and the component, and creates nothing else. A person must set up:

- A private runner project that includes the `renovate` component on a schedule (see [The runner project](https://preflight.apps.wayne.edu/docs/guides/renovate.html#the-runner-project)).
- The `RENOVATE_TOKEN` masked CI variable in that project, and optionally `GITHUB_COM_TOKEN`.
- A pipeline schedule on that project so the job runs regularly; weekly on Monday is a sensible default.
- To let Squire kit merge requests arrive refreshed, `squire_kit_tasks: true` under the include's `inputs:`, on a Preflight version that has the input (see [Squire kits](https://preflight.apps.wayne.edu/docs/guides/renovate.html#squire-kits)).

## The runner project [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#the-runner-project)

Warning

The runner project must stay private. It holds `RENOVATE_TOKEN`, a token that can open and merge merge requests across the group, and this repository is mirrored to public GitHub. Use a group bot account for the token, not a person's: the bot outlives any one maintainer, and the commits keep one stable author.

| Variable | Required | What it does |
| --- | --- | --- |
| `RENOVATE_TOKEN` | yes | Masked CI variable in the runner project; the job reads it straight from the project, the component does not map it. A project access token with Developer, or Maintainer where only Maintainers may merge. |
| `GITHUB_COM_TOKEN` | no | Masked CI variable in the runner project; the job reads it straight from the project, the component does not map it. Lookups against github.com do not hit anonymous rate limits. |

Warning

Do not add `RENOVATE_TOKEN: $RENOVATE_TOKEN` to your own `variables:`; that self-reference arrives as literal text.

The component writes its `config.js` at job time, so the `registryAliases` entry for the GitLab instance comes from the predefined `CI_SERVER_FQDN` variable. No hostname is stored in this repository.

## Related [#](https://preflight.apps.wayne.edu/docs/guides/renovate.html#related)

- [The `renovate` component](https://preflight.apps.wayne.edu/docs/guides/component-renovate.html)
- [The `squire-kit` component](https://preflight.apps.wayne.edu/docs/guides/component-squire-kit.html)
- [GitHub mirrors](https://preflight.apps.wayne.edu/docs/guides/github-mirrors.html)
- [Image pins](https://preflight.apps.wayne.edu/docs/guides/image-pins.html)
- [Quick start](https://preflight.apps.wayne.edu/docs/guides/quick-start.html)
