Skip to content

Shows the release task in the eval examples - #118

Merged
johnnyt merged 1 commit into
mainfrom
ece-qlc-release-task-eval-forms
Sep 30, 2026
Merged

johnnyt merged 1 commit into
mainfrom
ece-qlc-release-task-eval-forms

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 30, 2026

Copy link
Copy Markdown
Member

What

The mix encryptor.ecto.migrate and mix encryptor.ecto.verify moduledocs showed a bare bin/my_app eval '...' over the library call as the release path. An eval VM 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 on Ecto.Migrator.with_repo/2 and link the exit guide's section "Before step 4: the release task" (rendered as migrate-from-cloak.html#before-step-4-the-release-task; the anchor was checked in a local mix docs build).

ADR-0002 and ADR-0004 carry the same bare eval lines 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.md excludes documentation and ADRs.

Gate

Full mix quality green on this tree (database arm included): format, compile, doc links, dependencies, credo, docs, tests, dialyzer. The commit was made with a bare git commit over 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/1 on Ecto.Migrator.with_repo/2, starting the legacy vault and the new vault inside the callback, and its steps 4, 5 and 6 call run/2 and verify/2 through it. The mix tasks start the host application first (Encryptor.Ecto.Migrator.CLI's boot/0 runs app.start), which is why the Notes scope the gap to the eval form. 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 release eval form, 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

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
johnnyt force-pushed the ece-qlc-release-task-eval-forms branch from 39a1c25 to c606398 Compare September 30, 2026 05:53
@johnnyt
johnnyt merged commit e3581e6 into main Sep 30, 2026
1 check passed
@johnnyt
johnnyt deleted the ece-qlc-release-task-eval-forms branch September 30, 2026 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant