Versioning and releases

Versioning & releases

glyphora is pre-1.0. Patch releases preserve public APIs; minor releases may make breaking changes as the application layer matures. tui-core is the stability anchor and has received additive changes only since 0.2.

Pin an exact version in applications and review release notes before moving between minor versions.

Current coordinates

All published modules share one synchronized version under io.worxbend:

// Mill
def mvnDeps = Seq(mvn"io.worxbend::tui-dsl:0.10.0")

// sbt
libraryDependencies += "io.worxbend" %% "tui-dsl" % "0.10.0"

Applications normally need only tui-dsl. Lower-tier artifacts are tui-core, tui-terminal, tui-widgets, tui-runtime, and tui-macros.

Check Maven Central and release tags before choosing a version.

Compatibility policy

Change	Patch release	Minor release before 1.0
bug fix preserving signatures	yes	yes
additive widget or method	yes, when low risk	yes
source-breaking rename/removal	no	possible, documented
behavior change with migration work	no	possible, documented
binary compatibility guarantee	not yet	not yet

MiMa binary-compatibility gates are planned once a first published baseline is selected. Until then, recompile downstream code on upgrade even when moving between patch versions.

Types that will break when they grow

Adding a field to a case class changes the signatures of apply, copy and unapply, so downstream code compiled against the old shape fails with NoSuchMethodError — recompiling fixes it, but only if you know to. These public types are the ones most likely to gain fields, and are the reason the table above says "not yet" rather than "yes":

Type	Module	Why it will grow
Style	tui-core	new text attributes as terminals gain them
ElementProps	tui-dsl	every new element modifier lands here
Theme	tui-dsl	new semantic roles
RunnerConfig	tui-runtime	new loop options
Layout	tui-core	new constraint or flex behaviour

Before 1.0 these should move to a final class with a private constructor plus with* builders — the builder style Style already uses — so a new field is additive. The genuinely closed value types (Position, Size, Rect, Cell, KeyEvent, MouseEvent) are expected to stay case classes: their shape is fixed by what a terminal cell and a coordinate are.

Release process

Releases are Git tags named vX.Y.Z. Pushing a tag runs the Publish workflow, which publishes every TuiPublishModule to Maven Central with the same version and signed POM metadata.

Before a tag, maintainers should verify:

• formatter, compile, and complete test suite;
• public guide and Scaladoc changes;
• example JVM runs and native-image CI;
• module version in build.mill;
• migration notes for any source or behavior change.

License

MIT — use glyphora in open-source or commercial software, keeping the copyright and license notice.