Skip to content

docs: correct 0.8.0 setup and integration examples - #559

Merged
ChristopherDavenport merged 1 commit into
davenverse:mainfrom
dajiaohuang:docs/fuuid-080-usage-20261016
Oct 16, 2026
Merged

ChristopherDavenport merged 1 commit into
davenverse:mainfrom
dajiaohuang:docs/fuuid-080-usage-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown
Contributor

Summary

Correct the README and microsite instructions for the published 0.8.0 release:

  • State Scala 2.13/3 support and Circe 0.14.x. The 0.8.0 POMs/build target 2.13 and 3; the Scala 2.12 artifact metadata stops at 0.8.0-M4.
  • Import the Cats Effect 3 runtime in the REPL examples. Copying the existing examples into a consumer project currently fails at both unsafeRunSync() calls with “Could not find an implicit IORuntime.” Applications should prefer IOApp.
  • Describe the Doobie integration's Get/Put instances rather than claiming it supplies an implicit Meta[FUUID], matching the existing implementation.

No runtime implementation or dependency changes.

Validation

  • Original Examples block: consumer compilation fails at the two missing IORuntime call sites; adding the documented import fixes compilation.
  • Updated Examples, Circe and http4s snippets compile on Scala 2.13.18 and 3.3.8 against locally published artifacts from the base revision.
  • Five bounded public-use consumer tests pass on both Scala versions: parse/render/conversion/literal, Cats equality/hash/order/accumulating errors, normal generation and fixed name-based example, Circe value/key roundtrips, and in-memory http4s route/query handling.
  • githubWorkflowCheck and site/tlSite pass with sbt 1.11.7 / isolated JDK 17 on Windows. The generated workflow files were read using their committed LF bytes to avoid Windows CRLF checkout mismatches; they are not changed in this PR.
  • git diff --check passes.

The complete CI matrix, JS runtime tests, binary compatibility checks and database integration suites were not run locally. No database or external service was used for the consumer tests.

@ChristopherDavenport
ChristopherDavenport merged commit 7e1690a into davenverse:main Oct 16, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants