docs: restructure 1.x → 3.x upgrade around the 2.8 config converter#44
Merged
Merged
Conversation
Mirror upstream display-api-service #496: rework UPGRADE.md so the config migration is driven by the API's app:utils:convert-env-to-3x command (run on 1.x via `task upgrade_prep`, producing env.3x) instead of the sed-based env:migrate. - UPGRADE.md: add a pre-upgrade checklist that exports the running 1.x configuration BEFORE the stack is stopped (the converter reads the live app + admin/client config.json); make the converter the primary env-migration path and demote the sed rename to a <details> fallback; add #496-style checkbox checklists and a table of contents. - env:migrate: prefer env.3x when present — split off the trailing infrastructure advisory into .env.symfony.infra-advisory and write the rest to .env.symfony.migrated; fall back to the sed conversion of a 1.x .env.docker.local otherwise. Fold in the four MariaDB upgrade gaps from review: - mariadb service sets MARIADB_AUTO_UPGRADE=1 — the 10.x → 11.4 system-table upgrade now runs automatically on first boot against the carried-over data (also refreshes the healthcheck user); correct the old "auto-runs on first start" claim accordingly. - mariadb service sets stop_grace_period: 1m — no SIGKILL mid-flush right before the major cut; UPGRADE.md step 1 also verifies the 10.x server shut down cleanly. - document `rm -f docker-compose.yml` before `git checkout` (1.x leaves an untracked generated compose file that blocks the checkout). - document the data-volume / COMPOSE_PROJECT_NAME continuity check so a mismatched project name can't silently boot an empty database. Also gitignore the secret-bearing migration intermediates (env.3x, .env.symfony.migrated, .env.symfony.infra-advisory), fix the rollback to restore the 1.x plain-SQL dump under a regenerated 1.x compose file, and sync the README task table + MariaDB FAQ. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reworks the 1.x → 3.x
UPGRADE.mdso the configuration migration is driven by the API'sapp:utils:convert-env-to-3xcommand (run on the 1.x stack viatask upgrade_prepfrom #43, producingenv.3x) instead of the sed-basedenv:migrate. Follows the pattern and tone of upstream display-api-service#496, of which this repo is the "Option A" target.Also folds in the four MariaDB upgrade gaps surfaced in review.
Features Added
config.json). The sed rename is demoted to a<details>fallback for pre-2.8 installs.env:migrateprefersenv.3x. When present, it splits off the trailing infrastructure advisory (COMPOSE_*/PHP_*/NGINX_*/MARIADB_*) into.env.symfony.infra-advisoryand writes the rest to.env.symfony.migrated; otherwise it falls back to the sed conversion of a 1.x.env.docker.local.MariaDB gaps folded in
MARIADB_AUTO_UPGRADE=1on the mariadb service — the 10.x → 11.4 system-table upgrade now runs automatically on first boot against the carried-over data (also refreshes the healthcheck user, rescuing pre-2023 data dirs). Corrects the old "auto-runs on first start" claim.stop_grace_period: 1mon the mariadb service — no SIGKILL mid-flush before the major cut; the guide also verifies the 10.x server shut down cleanly.rm -f docker-compose.ymlbeforegit checkout— 1.x leaves an untracked generated compose file that otherwise blocks the checkout.COMPOSE_PROJECT_NAMEcontinuity check — so a mismatched project name can't silently boot an empty database.Files Changed
UPGRADE.md— restructured as above; no step dropped (backups, MariaDB upgrade, first boot, validation, rollback all retained).docker-compose.yml—MARIADB_AUTO_UPGRADE=1+stop_grace_period: 1mon the mariadb service.Taskfile.yml—env:migrateenv.3x-aware with sed fallback..gitignore— ignore secret-bearing migration intermediates (env.3x,.env.symfony.migrated,.env.symfony.infra-advisory).README.md—env:migratetask description + MariaDB major-upgrade FAQ updated for auto-upgrade.CHANGELOG.md— entries under[Unreleased] — release/3.0.0.Test Plan
docker compose configrendersMARIADB_AUTO_UPGRADE: "1"andstop_grace_period: 1m0son the mariadb service (profile active).task env:migrateexercised both ways: with anenv.3xfixture (splits app env from advisory) and without (sed fallback on a synthetic.env.docker.local).task --listparses;scripts/check-tasks-readme.shpasses (README task block in sync).markdownlint(repo's pinned image + config) clean onUPGRADE.md,README.md,CHANGELOG.md.🤖 Generated with Claude Code