Skip to content

Commit c1a98aa

Browse files
authored
docs(release): prep v1.6.8 — CHANGELOG summary + migration table
Release-prep documentation pass for v1.6.8. Reformats the in-progress CHANGELOG entry with: - Feature summary section grouping the public-API changes (markdown links in project titles, 4 new contemporary BusinessTheme presets) and the under-the-hood polish (registry symmetry, negative tests, NodeRegistry @SInCE note) - Migration table calling out what existing users need to know (zero breaking changes, japicmp clean — semver PATCH) - New ### Web subsection declaring the Next.js showcase site (introduced in #123) as the official GitHub Pages deploy target from v1.6.8 onward - Pointer to test-your-document.md guide on develop (lands on main with the cut) Sets up cut-release.ps1 Step 2 (CHANGELOG date flip) to convert '## v1.6.8 — Planned' to '## v1.6.8 — $(today)' cleanly when the release runs.
1 parent b8e775f commit c1a98aa

1 file changed

Lines changed: 55 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 55 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,61 @@ follow semantic versioning; release dates are ISO 8601.
55

66
## v1.6.8 — Planned
77

8-
**CV v2 migration completion + senior-review polish.** Scope being
9-
assembled — entries are filled in as work lands on `develop`. The
10-
headline addition is parser-level support for inline markdown links
11-
(`[label](url)`) so CV/cover-letter authors can render project /
12-
education entry titles as hyperlinks without changing the existing
13-
`CvRow` data shape; the rest is small build and code-hygiene
14-
follow-ups carried over from the v1.6.7 senior review (see
15-
[ROADMAP.md](ROADMAP.md) and the private taskboard). No breaking
16-
changes are planned.
8+
**CV v2 migration completion + design-token expansion.** v1.6.8
9+
finishes the CV v2 migration with hyperlink-aware project / entry
10+
titles: a row authored as `"[GraphCompose](https://github.com/x/y)
11+
(Java, PDFBox)"` now renders the title as a clickable link in the
12+
final PDF, with the technology stack remaining a plain
13+
` (Java, PDFBox)` tail. The mechanism is a small extension to
14+
the inline-Markdown parser used by every CV / cover-letter body
15+
row — the `[label](url)` syntax produces a `RichText.link(...)`
16+
run; bare brackets stay literal; everything else (`**bold**`,
17+
`*italic*`, `_italic_`) keeps working as before. The release also
18+
ships four contemporary `BusinessTheme` factory presets
19+
(`nordic()`, `editorial()`, `cinematic()`, `monochrome()`)
20+
alongside the classic / modern / executive trio, expanding the
21+
built-in design-token range to seven presets. Senior-review
22+
follow-ups from v1.6.7 round out the release: the two registry
23+
mutation entry points on `DocumentSession` are now fully
24+
interchangeable (both refuse to mutate a closed session and both
25+
invalidate the layout cache), `target-branch: develop` is pinned
26+
in Dependabot config so future bumps land on the integration
27+
branch, and `logback-classic` rolls forward to 1.5.34 which
28+
fixes [CVE-2026-9828](https://www.cve.org/cverecord?id=CVE-2026-9828)
29+
(deserialisation whitelist bypass).
30+
31+
**Zero breaking public API changes.** The `japicmp` gate against
32+
the v1.6.7 baseline reports `semver PATCH, compatible bug fix`
33+
across every PR in the cycle. New `BusinessTheme` factories are
34+
pure additions; `MarkdownInline.append` and `plainText` extend
35+
their behaviour without changing their signatures; `ProjectLabel.
36+
parse` keeps its two-field record shape (the `title()` field now
37+
preserves Markdown rather than returning a pre-flattened
38+
projection, but the type contract is unchanged and the visible
39+
text projection is one call away via `MarkdownInline.plainText(
40+
title)`). 1058 tests pass at the release-prep tip.
41+
42+
**Migration from v1.6.7.** No code changes required for typical
43+
usage. If you build a custom renderer on top of
44+
`ProjectLabel.parse`:
45+
46+
- Old `title()` was already the visible plain text (emphasis +
47+
link syntax stripped). New `title()` preserves the original
48+
inline-Markdown. Wrap with `MarkdownInline.plainText(...)` to
49+
recover the old behaviour, or route through
50+
`MarkdownInline.append(rich, title, style)` to get
51+
emphasis / link rendering for free (the same path
52+
`ProjectRenderer` now uses).
53+
- `MarkdownInline.append` consumers automatically pick up link
54+
rendering for `[label](url)` syntax. If any CV / cover-letter
55+
fixture in your codebase contained a literal `[...](...) `
56+
string that previously rendered as text, it will now render
57+
as a hyperlink. Escape with HTML entities or restructure the
58+
string if you need to keep it literal.
59+
60+
The next release is **v1.7.0** — the additive canonical-DSL
61+
feature minor (LineBuilder.dashed, inline shapes, TimelineBuilder,
62+
dx shortcuts, recipes docs). See [ROADMAP.md](ROADMAP.md).
1763

1864
### Fixes
1965

0 commit comments

Comments
 (0)