Record the release decisions and the work they set #11

Merged
lilleman merged 3 commits from release-decisions into main 2026-09-14 23:32:29 +02:00
Showing only changes of commit 3e353dece7 - Show all commits
+46 -22
View File
@@ -1,28 +1,52 @@
# Release checklist
What to settle before the first tag, then the work that follows in a later,
data-heavy release.
## Before the first release
## Before the first release — settle the record flag and API contract
The record API lands first, so the data update can use it.
- `--format` vocabulary — confirm `text`, `json`, `ndjson`, `csv`, `sql`; the
`json`-as-array vs `ndjson`-as-lines split; `--table` (the SQL INSERT target);
the `--separator` rejection on record formats; and the exit codes (misuse 2,
runtime 1).
- Library surface — confirm `Record`, `FakeRecord`, `NewRecordTemplate`,
`RecordTemplate`, `Column`/`Columns()`, and the `JSON()`, `CSVHeader()`,
`CSVLine()`, `SQLInsert()` serializers.
- Typed scalars — columns are strings today (`"42"`, quoted SQL). Confirm that
stays out of scope, or add a per-column `kind` before the tag.
- Struct-filling — `fake:"..."` tags (reflection over an arbitrary struct) stay
out of scope; `Columns()` hands the caller the values to map themselves.
Confirm.
- Independent reference draw — within one record every tailed reference to a
category is one draw, with no spelling for "these columns should disagree".
Confirm the per-record contract, or add the spelling.
### Record API
## Later, in a data-heavy release
- Rename the record entry points after the string ones: `Record(path)` becomes
`FakeRecord(path)`, and `FakeRecord(inline)` becomes `FakeRecordTemplate(inline)`.
- Typed columns — a column declares its type, so `json` writes `42` rather than
`"42"` and `sql` an unquoted literal: string, integer, number, boolean, and a
way to write null. A template that can render a value its type rejects is a
load error. The option key is reserved from then on, so a common column name
like `type` is a poor pick.
- Struct-filling — fill a Go struct from `fake:"…"` tags holding a path or an
inline template, for parity with gofakeit and go-faker. The field's Go type is
the column type, through the same conversion and load checks as typed columns,
and a nested struct is its own draw group. Revise the Decision "A record is a
template seen as columns, not a second schema format" with that reason.
- Draw groups — references into one category share one draw per render (one
record, or one `Fake`) in both views; each `repeat` iteration draws anew, and a
bare reference draws each time. An option naming a draw group splits a render
into several entities. Replaces the Decision "A record shares one reference draw
per category". Each expectation becomes a test:
- `first`, `last` and `email` reading `person` → one person
- `from_first`/`from_last` grouped `from`, `to_first`/`to_last` grouped `to` → two people
- `host`, plus `guests` repeated 3 times → four people
- `code` and `symbol` sibling fields reading `currency`, as `{code} {symbol}` → a matching pair
- `{a} & {b}`, each reading `person` → one person, or two when `a` and `b` name different groups
- two bare `{/sv_SE.word}` → two words
- Shipped-data de-duplication — `email.json`'s `local` is a drifted copy of
`username.json`; fold it in when the shipped set grows and we add lots more
data.
### Data
- Major data update. Shipped categories render as records with their building
blocks as columns (`sv_SE.person` → `femalefirst`, `malefirst`; `misc.uuid` →
`variant`), and `sv_SE.address` draws its postal code apart from its locality.
- Decide what a version promises about shipped data: its paths, its record
columns, and whether a seed renders the same output across versions.
- `email.local` and `username` share their handle lists, while their name
variants differ on purpose. Share the lists only if that is a clean win.
### Release
- Versioning — semver tags, `vX.Y.Z`. From v2 the module path carries `/vN`
(`go.mod`, imports, the README's install lines). Pick the first tag, and reword
the Decision "After the first tag, a new fence is a major version" to match.
- Changelog — a `## Changelog` section in the README, added with the first tag;
the fence Decision's "changelog" points there.
- CLI without Go — investigate prebuilt binaries: GoReleaser publishing to Gitea
releases, a container image, Homebrew and Scoop.
- Homepage — a simple page for fejkdata.