Add ADR: no manual migration steps between versions - #570
Open
mpfl wants to merge 1 commit into
Open
Conversation
Proposed after a demo instance upgrade skipped an undocumented manual config step, causing avoidable downtime. Status is "proposed" pending discussion with devs on the open scope/sequencing/enforcement questions. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
robleney-ardc
self-requested a review
August 21, 2026 06:47
robleney-ardc
approved these changes
Aug 21, 2026
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
2 participants
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
Adds a proposed ADR (
doc/adr/2026-07-17_no-manual-migration-steps.md) stating that migrations between versions must be scripted, not left as manual written instructions — scripts may still be manually triggered.Prompted by a recent RAiD US demo instance upgrade where an undocumented manual step (creating a config file, required by an interim version) was missed, causing avoidable downtime.
Status is proposed, not final — the ADR includes an "Open questions" section for the dev team to weigh in on before this is accepted: scope (DB/app-level only vs. infra-adjacent config like Keycloak/SATOSA), the mechanism for making required scripts obvious to an operator, graceful recovery from partial failure/re-run, and automatic in-order sequencing across multiple versions.
Test plan
N/A — documentation only.