Repository navigation
Adds an upgrading page for a host from 0.4 - #47
Merged
Merged
Conversation
A how-to under docs/upgrading.md in the family's host-page shape: a host moving from 0.4.0 to 0.5.0, and on to the 0.5.1 patch, changes nothing. The page names what a host may start doing (validate a document against the shipped draft-07 schema through StatifierDatamodel.Schema), the read-check wrapper rule 0.5.0's Types documentation states, and that 0.5.1 is documentation only. The page is an extra in a new Upgrading group and ships in the package files, since the README's Do list links it by a relative path. Refs: sd-01x
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
A new how-to,
docs/upgrading.md, "Upgrading a host from 0.4 to 0.5", in the family's host-page shape (one##per step, NONE where a host changes nothing, what the release added left in the CHANGELOG):StatifierDatamodel.Schema.path/0andjson/0(advisory;Index.index/1answers as before). Worth knowing: the rule 0.5.0'sStatifierDatamodel.Typesdocumentation states for a relation wrapped aroundsatisfies/3.mix.exs: the page is an extra in a newUpgradinggroup (after Explanation, the order the docs comment fixes), and it joins the package files because the README links it by a relative path (the Doc links stage refuses a README relative link to a file outside the package files).README.md: one line in the documentation map's "Do" list.No CHANGELOG entry and no fragment:
changelog.d/README.mdleaves documentation out. No version bump.Direction check
Every claim on the page was checked against the CHANGELOG and the code at the tags.
git diff v0.4.0 v0.5.0 -- lib privtouches two lib files and adds the schema file:lib/statifier_datamodel/schema.ex(new,path/0andjson/0, the moduledoc's "Advisory, never admission" section),lib/statifier_datamodel/types.ex(moduledoc only: the section "A consumer's own relation above this one"), andpriv/schemas/datamodel-document.schema.json(new,$schemadraft-07, title "Datamodel document, version 1");lib/statifier_datamodel/index.exis untouched, which is what "answers exactly as before" rests on (CHANGELOG## [0.5.0] 2026-09-26).git diff v0.5.0 v0.5.1 -- lib privis empty (CHANGELOG## [0.5.1] 2026-10-05: "The code is unchanged from 0.5.0"). Theelixir: "~> 1.18"requirement is the same at v0.4.0 and v0.5.1. The sibling requirement claim was read from each tag'smix.exs: every statifier_blocks tag from v0.35.0 through v0.42.1, and statifier_ui v0.10.1 and v0.10.2, require{:statifier_datamodel, "~> 0.4"}. The upgrade host in statifier_examples crossed this step in PR 190 (0.4.0 to 0.5.1, suite green at each commit) and its "What a host changes" section is NONE, with no item a host must change; the page agrees. The diff removes no line outside themix.exslines the edit replaces: the last entry of the extras list and ofgroups_for_extras, each of which gains a comma, and the package files comment and list.Test plan
mix qualitygreen on the committed tree: format, compile, credo, dialyzer, deps, docs (no warnings), doc links, tests with coverage.upgrading.htmlunder an Upgrading sidebar group, and the README's link resolves to it.mix hex.build --unpackputsdocs/upgrading.mdin the package.