Skip to content

Commit 4016ac2

Browse files
committed
docs(release): define 0.5.x-0.9.x release-readiness lane toward 1.0.0
1 parent b536380 commit 4016ac2

5 files changed

Lines changed: 30 additions & 0 deletions

File tree

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The changelog is grouped by release tags (`vX.Y.Z`) and includes an `Unreleased`
2626
- βœ… Kept the MainDemo `DockDebugOverlay` HUD as a local debug-toggle option after the overlay fixes (no default-on requirement).
2727

2828
### Documentation
29+
- βœ… Added an explicit release-readiness version lane plan (`0.5.x` to `0.9.x`) and documented the policy split between continuous release readiness (`0.x`) and controlled public launch (`1.0.0`).
2930
- βœ… Updated roadmap/status/done docs to mark the `DockDebugOverlay` HUD fixes follow-up as completed (while noting the MainDemo HUD remains opt-in) and return current priority focus to the Phase 3 UX backlog.
3031

3132
## v0.4.0 - 2026-02-25

β€ŽDONE.mdβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@ SnapFX has been fully implemented with core functionality and is production-read
131131
- βœ… ADR documentation baseline added: significant design decisions are now captured under `docs/adr/` and reflected in architecture/API docs
132132
- βœ… Markdown documentation consistency tests now keep Unicode icon constants readable via inline icon comments
133133

134+
- βœ… Release-readiness version lane planning is now documented (`0.5.x` to `0.9.x` readiness phases, RC drills, and controlled `1.0.0` public-launch cut policy).
135+
134136
### Resources
135137
- βœ… `snapfx.css` - Native Modena theme styling
136138
- βœ… Icon set from Yusuke Kamiyamane (64 icons in 16px size)

β€ŽRELEASING.mdβ€Ž

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ Inspect the resolved version:
1414
./gradlew version
1515
```
1616

17+
## Release-Ready Track (`0.x`) vs Public Launch (`1.0.0`)
18+
19+
- Current strategy is **release-ready, not release-now**:
20+
- keep release automation and artifacts continuously healthy on `0.x`
21+
- continue feature development in parallel
22+
- Use RC drill tags (`v0.x.y-rc.z`) to validate full release automation without committing to a public stable cut.
23+
- Only cut `v1.0.0` after an explicit go-public decision and after release-readiness gates are green (docs, packaging, publishing, QA, platform validation).
24+
- Before the final `v1.x` cut, remove the temporary macOS jpackage app-version major-floor workaround so demo and core versions match exactly again.
25+
1726
## Branch and Release Flow
1827

1928
- Current phase: active implementation happens on `main`.

β€ŽROADMAP.mdβ€Ž

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,22 @@ This roadmap keeps a high-level progress view plus planned/proposed work; detail
412412

413413
---
414414

415+
### 8.1.1 Release-Ready Version Lane (`0.5.x` to `1.0.0`)
416+
**Priority**: 🟑 High
417+
418+
- πŸ“‹ **Policy baseline (not release-now)**: Keep SnapFX continuously release-ready while feature development continues; cut `1.0.0` only after an explicit go-public decision.
419+
- πŸ“‹ **`0.5.x` Documentation baseline**: Complete public API JavaDoc and keep API docs generation quality gates green.
420+
- πŸ“‹ **`0.6.x` Public docs + domain**: Publish API docs via GitHub Pages and align `snapfx.org` routing/documentation structure.
421+
- πŸ“‹ **`0.7.x` Packaging hardening**: Finalize cross-platform demo packaging validation, smoke-check checklists, and release-asset checksum flow.
422+
- πŸ“‹ **`0.8.x` Publishing readiness**: Finalize Maven Central CI signing/staging/release flow and maintainer release checklist.
423+
- πŸ“‹ **`0.9.x` Release rehearsal + freeze**: Run end-to-end RC drills (`v0.9.x-rc.y`), close final blockers, and freeze public API for `1.0.0`.
424+
- πŸ“‹ **`1.0.0` stable cut**: Tag and publish the first stable public release once all release-readiness gates are green.
425+
- πŸ“‹ **Scope guard**: Keep optional backlog items (for example video tutorials, layout designer, major UX expansions) out of the `1.0.0` critical path unless explicitly promoted.
426+
427+
**Estimated Time**: Iterative across `0.5.x` to `0.9.x`
428+
429+
---
430+
415431
### 8.2 Quality Assurance
416432
**Priority**: πŸ”΄ Critical
417433

β€ŽSTATUS.mdβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
βœ… **Demo Runtime Packaging Baseline**: `org.beryx.jlink` now configures `:snapfx-demo:jlink`, `:snapfx-demo:jpackageImage`, and `:snapfx-demo:packageJPackageImageZip`, including OS-specific app icons (`.ico`/`.icns`/`.png`) and a temporary macOS-compatible jpackage app-version normalization (major version floor `1`, planned removal at first `v1.x` release)
1818
βœ… **Cross-Platform Demo Release Assets**: Tag releases now build `jpackage` demo ZIPs on Windows/macOS/Linux and publish them with deterministic OS-specific filenames (`snapfx-demo-jpackage-image-<os>-<tag>.zip`)
1919

20+
βœ… **Release-Ready Version Strategy**: Roadmap/releasing docs now define an explicit `0.5.x` to `0.9.x` readiness lane with RC drill tags and a controlled `1.0.0` public-launch cut.
21+
2022
## Documentation Scope
2123

2224
- βœ… [STATUS.md](STATUS.md) tracks only the current state: build health, current capabilities, and open issues.

0 commit comments

Comments
Β (0)