Shows the release task in the eval examples - #118
Merged
Merged
Conversation
The migrate and verify task moduledocs showed a bare bin/my_app eval over the library call as the release path. An eval VM starts nothing, so that call ran with neither the repository nor either vault up. Both moduledocs now wrap the call in the with_repo release function and link the exit guide's "Before step 4: the release task" section. ADR-0002 and ADR-0004 carry the same bare eval lines in their worked examples; each takes a dated foot Note that reads them through the guide's release function. The Notes decide nothing; zero removed lines. No changelog fragment (documentation is excluded). Refs: ece-qlc
johnnyt
force-pushed
the
ece-qlc-release-task-eval-forms
branch
from
September 30, 2026 05:53
39a1c25 to
c606398
Compare
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.
What
The
mix encryptor.ecto.migrateandmix encryptor.ecto.verifymoduledocs showed a barebin/my_app eval '...'over the library call as the release path. AnevalVM loads the configuration and starts nothing, so that call runs with neither the repository nor either vault up. Both moduledocs now show the call inside the release function built onEcto.Migrator.with_repo/2and link the exit guide's section "Before step 4: the release task" (rendered asmigrate-from-cloak.html#before-step-4-the-release-task; the anchor was checked in a localmix docsbuild).ADR-0002 and ADR-0004 carry the same bare
evallines in their worked examples. Each takes one dated foot Note, appended after the last section in the file, that names its three examples by the lines that introduce them and reads each through the guide's release function. The Notes decide nothing;git diff origin/main -- docs/adr/shows zero removed lines. No changelog fragment:changelog.d/README.mdexcludes documentation and ADRs.Gate
Full
mix qualitygreen on this tree (database arm included): format, compile, doc links, dependencies, credo, docs, tests, dialyzer. The commit was made with a baregit commitover the staged tree, byte-identical (git write-tree) to the tree that run passed on.Review (in-turn, gate tier)
Direction check: every claim in the moduledoc and Note text was checked against the code and records on main at 704ed27. The guide section "Before step 4: the release task" defines
MyApp.Release.with_encryption/1onEcto.Migrator.with_repo/2, starting the legacy vault and the new vault inside the callback, and its steps 4, 5 and 6 callrun/2andverify/2through it. The mix tasks start the host application first (Encryptor.Ecto.Migrator.CLI'sboot/0runsapp.start), which is why the Notes scope the gap to theevalform. ADR-0002's examples sit under "Rehearse, then run, from a release:" and "And the acceptance check:" in its worked example; ADR-0004's under its "Step 4", "Step 5" and "Step 6" lead lines. ADR-0004 decision 10 is the one that has the how-to lead with the releaseevalform, and decision 6 is the no-extra-capability rule the Note leaves unchanged. Both Notes are additions only and close with the bead provenance line.Ruled by the operator, 2026-09-29 (scheduled as a docs fix; one Note per record, zero removed lines).
Refs: ece-qlc