From 311e92cfc6d8f87b40d57288db92302352f9cd35 Mon Sep 17 00:00:00 2001 From: Rene Nochebuena Guerrero Date: Fri, 7 Aug 2026 18:53:42 -0600 Subject: [PATCH] docs(web): fix non-compiling doc examples; bump to v1.1.0 Coordinated framework release. Documentation-only code changes plus the shared version bump (folds the never-tagged 1.0.1 contracts pin into 1.1.0). - mw.Recover() -> mw.Recover(logger): web/mw/doc.go, web/server/doc.go, web/server/server.go. - health.NewHandler(...) -> ....ServeHTTP (chi Get takes HandlerFunc): web/server/doc.go, web/doc.go, web/health/doc.go. - go.mod: contracts, core -> v1.1.0 (via go get + go mod tidy). Verified by compiling the example patterns against the real API. Badge -> v1.1.0. --- CHANGELOG.md | 19 +++++++++++++++---- README.md | 2 +- doc.go | 2 +- go.mod | 4 ++-- go.sum | 8 ++++---- health/doc.go | 4 ++-- mw/doc.go | 2 +- server/doc.go | 4 ++-- server/server.go | 2 +- 9 files changed, 29 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 602f53c..75b6a83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,13 +6,24 @@ This module adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html --- -## [1.0.1] — 2026-05-28 +## [1.1.0] — 2026-08-07 + +Coordinated framework release. Documentation fixes plus the framework version bump +(which finally makes the previously-drafted `contracts` v1.1.0 pin real). + +### Fixed + +- **Package doc examples didn't compile.** Verified by compiling the example patterns + against the real API: + - `mw.Recover()` -> `mw.Recover(logger)` — the recover middleware takes a `logging.Logger` + (`server`, `mw` package docs and `server.go`). + - `health.NewHandler(logger, …)` -> `health.NewHandler(logger, …).ServeHTTP` — the handler + returns `http.Handler`, but chi's `Get` takes `http.HandlerFunc`; same for + `NewHandlerWithConfig` (`server`, `web`, `health` package docs). ### Changed -- Bumped `code.nochebuena.dev/einherjar/contracts` dependency from v1.0.0 to v1.1.0. - No code changes — MVS selects v1.1.0 automatically when a consumer (e.g. `auth`) - requires the new `SecurityBag` API. This pin makes the minimum explicit. +- Bumped `contracts` and `core` to v1.1.0 (framework version alignment). --- diff --git a/README.md b/README.md index cd97cfa..a8d3df6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # einherjar/web -[![version](https://img.shields.io/badge/version-v1.0.0-5C4EE5?style=flat-square)](https://code.nochebuena.dev/einherjar/web) +[![version](https://img.shields.io/badge/version-v1.1.0-5C4EE5?style=flat-square)](https://code.nochebuena.dev/einherjar/web) [![license](https://img.shields.io/badge/license-AGPL--3.0-22863A?style=flat-square)](LICENSE) [![go](https://img.shields.io/badge/Go-1.26+-00ADD8?style=flat-square&logo=go&logoColor=white)](https://go.dev) diff --git a/doc.go b/doc.go index 02c11cf..95094a8 100644 --- a/doc.go +++ b/doc.go @@ -18,7 +18,7 @@ // lc := launcher.New(logger) // // srv := web.New(logger) -// srv.Get("/health", health.NewHandler(logger, db, cache)) +// srv.Get("/health", health.NewHandler(logger, db, cache).ServeHTTP) // // lc.Append(srv) // lc.BeforeStart(func() error { diff --git a/go.mod b/go.mod index dffa681..569a6de 100644 --- a/go.mod +++ b/go.mod @@ -3,8 +3,8 @@ module code.nochebuena.dev/einherjar/web go 1.26 require ( - code.nochebuena.dev/einherjar/contracts v1.0.0 - code.nochebuena.dev/einherjar/core v1.0.0 + code.nochebuena.dev/einherjar/contracts v1.1.0 + code.nochebuena.dev/einherjar/core v1.1.0 github.com/go-chi/chi/v5 v5.2.1 github.com/google/uuid v1.6.0 golang.org/x/time v0.11.0 diff --git a/go.sum b/go.sum index 720015b..a9cfb7c 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,7 @@ -code.nochebuena.dev/einherjar/contracts v1.0.0 h1:hRudEtOIqU7vwedYLsCh8+9q5dCnKb61qX+zibqImRU= -code.nochebuena.dev/einherjar/contracts v1.0.0/go.mod h1:ccltUtrFb5+MEJdkx2VVEUL+xC5pupVlVVsMM8AlCWI= -code.nochebuena.dev/einherjar/core v1.0.0 h1:AueZgfjp3+rQmDKOxmJQ945TTh+sqC1l/xJdTOdbr9w= -code.nochebuena.dev/einherjar/core v1.0.0/go.mod h1:0IywfRnJXX9xXQO6iPVaq2QDlXbbpXrB8A4T7gO8nE4= +code.nochebuena.dev/einherjar/contracts v1.1.0 h1:GsGr6reyrd9qCc7D8CqbT1LWPTeeK9lT4r4EdsNA5Ro= +code.nochebuena.dev/einherjar/contracts v1.1.0/go.mod h1:ccltUtrFb5+MEJdkx2VVEUL+xC5pupVlVVsMM8AlCWI= +code.nochebuena.dev/einherjar/core v1.1.0 h1:zxj9bFPthEEFRnvWV/vgNZqWa2y/kAo3p5pODWablyk= +code.nochebuena.dev/einherjar/core v1.1.0/go.mod h1:Ot2JbjsnZ33Ed5C9Ev1kSn2PW+F4dLz/LRwIUh+fYt0= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/gabriel-vasile/mimetype v1.4.12 h1:e9hWvmLYvtp846tLHam2o++qitpguFiYCKbn0w9jyqw= diff --git a/health/doc.go b/health/doc.go index 13d1322..729d14f 100644 --- a/health/doc.go +++ b/health/doc.go @@ -12,12 +12,12 @@ // // # Example // -// srv.Get("/health", health.NewHandler(logger, db, cache, storage)) +// srv.Get("/health", health.NewHandler(logger, db, cache, storage).ServeHTTP) // // Or with custom timeout: // // srv.Get("/health", health.NewHandlerWithConfig(logger, // health.Config{CheckTimeout: 3 * time.Second}, // db, cache, -// )) +// ).ServeHTTP) package health diff --git a/mw/doc.go b/mw/doc.go index 2b57843..bc8e985 100644 --- a/mw/doc.go +++ b/mw/doc.go @@ -6,7 +6,7 @@ // # Recommended middleware order (outermost first) // // server.WithMiddleware( -// mw.Recover(), +// mw.Recover(logger), // mw.RequestID(uuid.NewString), // mw.RequestLogger(logger), // mw.CORS([]string{"https://example.com"}), diff --git a/server/doc.go b/server/doc.go index 7e056e8..feace68 100644 --- a/server/doc.go +++ b/server/doc.go @@ -12,14 +12,14 @@ // // srv := server.New(logger, server.Config{Port: 8080}, // server.WithMiddleware( -// mw.Recover(), +// mw.Recover(logger), // mw.RequestID(myIDGenerator), // mw.RequestLogger(logger), // mw.CORS([]string{"https://example.com"}), // ), // ) // -// srv.Get("/health", health.NewHandler(logger, db)) +// srv.Get("/health", health.NewHandler(logger, db).ServeHTTP) // // lc := launcher.New(logger) // lc.Append(srv) diff --git a/server/server.go b/server/server.go index e5eba78..6e3748c 100644 --- a/server/server.go +++ b/server/server.go @@ -7,7 +7,7 @@ // // srv := server.New(logger, server.Config{Port: 8080}, // server.WithMiddleware( -// mw.Recover(), +// mw.Recover(logger), // mw.RequestID(uuid.NewString), // mw.RequestLogger(logger), // ),