This commit is contained in:
Peter Kieltyka 2021-02-27 19:11:55 -05:00 committed by GitHub
parent c9e87efe96
commit fe3708ee6c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
33 changed files with 60 additions and 50 deletions

View file

@ -1,5 +1,15 @@
# Changelog
## v5.0.0 (2021-02-27)
- chi v5, `github.com/go-chi/chi/v5` introduces the adoption of Go's SIV to adhere to the current state-of-the-tools in Go.
- chi v1.5.x did not work out as planned, as the Go tooling is too powerful and chi's adoption is too wide.
The most responsible thing to do for everyone's benefit is to just release v5 with SIV, so I present to you all,
chi v5 at `github.com/go-chi/chi/v5`. I hope someday the developer experience and ergonomics I've been seeking
will still come to fruition in some form, see https://github.com/golang/go/issues/44550
- History of changes: see https://github.com/go-chi/chi/compare/v1.5.4...v5.0.0
## v1.5.4 (2021-02-27)
- Undo prior retraction in v1.5.3 as we prepare for v5.0.0 release

View file

@ -20,7 +20,7 @@ and [docgen](https://github.com/go-chi/docgen). We hope you enjoy it too!
## Install
`go get -u github.com/go-chi/chi`
`go get -u github.com/go-chi/chi/v5`
## Features
@ -49,8 +49,8 @@ package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func main() {
@ -76,8 +76,8 @@ above, they will show you all the features of chi and serve as a good form of do
import (
//...
"context"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func main() {

View file

@ -4,7 +4,7 @@ import (
"errors"
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
type Handler func(w http.ResponseWriter, r *http.Request) error

View file

@ -3,8 +3,8 @@ package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func init() {

View file

@ -26,8 +26,8 @@ import (
"path/filepath"
"strings"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func main() {

View file

@ -9,8 +9,8 @@ import (
"os/signal"
"time"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/valve"
)

View file

@ -3,8 +3,8 @@ package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func main() {

View file

@ -20,8 +20,8 @@ import (
"net/http"
"time"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func main() {

View file

@ -16,8 +16,8 @@ import (
"net/http"
"time"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
"github.com/sirupsen/logrus"
)

View file

@ -47,8 +47,8 @@ import (
"net/http"
"strings"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/docgen"
"github.com/go-chi/render"
)
@ -105,7 +105,7 @@ func main() {
if *routes {
// fmt.Println(docgen.JSONRoutesDoc(r))
fmt.Println(docgen.MarkdownRoutesDoc(r, docgen.MarkdownOpts{
ProjectPath: "github.com/go-chi/chi",
ProjectPath: "github.com/go-chi/chi/v5",
Intro: "Welcome to the chi/_examples/rest generated docs.",
}))
return

View file

@ -2,28 +2,28 @@
"router": {
"middlewares": [
{
"pkg": "github.com/go-chi/chi/middleware",
"pkg": "github.com/go-chi/chi/v5/middleware",
"func": "RequestID",
"comment": "RequestID is a middleware that injects a request ID into the context of each\nrequest. A request ID is a string of the form \"host.example.com/random-0001\",\nwhere \"random\" is a base62 random string that uniquely identifies this go\nprocess, and where the last number is an atomically incremented request\ncounter.\n",
"file": "github.com/go-chi/chi/middleware/request_id.go",
"line": 63
},
{
"pkg": "github.com/go-chi/chi/middleware",
"pkg": "github.com/go-chi/chi/v5/middleware",
"func": "Logger",
"comment": "Logger is a middleware that logs the start and end of each request, along\nwith some useful data about what was requested, what the response status was,\nand how long it took to return. When standard output is a TTY, Logger will\nprint in color, otherwise it will print in black and white. Logger prints a\nrequest ID if one is provided.\n\nAlternatively, look at https://github.com/pressly/lg and the `lg.RequestLogger`\nmiddleware pkg.\n",
"file": "github.com/go-chi/chi/middleware/logger.go",
"line": 26
},
{
"pkg": "github.com/go-chi/chi/middleware",
"pkg": "github.com/go-chi/chi/v5/middleware",
"func": "Recoverer",
"comment": "Recoverer is a middleware that recovers from panics, logs the panic (and a\nbacktrace), and returns a HTTP 500 (Internal Server Error) status if\npossible. Recoverer prints a request ID if one is provided.\n\nAlternatively, look at https://github.com/pressly/lg middleware pkgs.\n",
"file": "github.com/go-chi/chi/middleware/recoverer.go",
"line": 18
},
{
"pkg": "github.com/go-chi/chi/middleware",
"pkg": "github.com/go-chi/chi/v5/middleware",
"func": "URLFormat",
"comment": "URLFormat is a middleware that parses the url extension from a request path and stores it\non the context as a string under the key `middleware.URLFormatCtxKey`. The middleware will\ntrim the suffix from the routing path and continue routing.\n\nRouters should not include a url parameter for the suffix when using this middleware.\n\nSample usage.. for url paths: `/articles/1`, `/articles/1.json` and `/articles/1.xml`\n\n func routes() http.Handler {\n r := chi.NewRouter()\n r.Use(middleware.URLFormat)\n\n r.Get(\"/articles/{id}\", ListArticles)\n\n return r\n }\n\n func ListArticles(w http.ResponseWriter, r *http.Request) {\n\t urlFormat, _ := r.Context().Value(middleware.URLFormatCtxKey).(string)\n\n\t switch urlFormat {\n\t case \"json\":\n\t \trender.JSON(w, r, articles)\n\t case \"xml:\"\n\t \trender.XML(w, r, articles)\n\t default:\n\t \trender.JSON(w, r, articles)\n\t }\n}\n",
"file": "github.com/go-chi/chi/middleware/url_format.go",

View file

@ -5,7 +5,7 @@ import (
"net/http"
"strings"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func main() {

View file

@ -11,8 +11,8 @@ package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
)
func main() {

View file

@ -3,7 +3,7 @@ package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
type todosResource struct{}

View file

@ -3,7 +3,7 @@ package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
type usersResource struct{}

View file

@ -14,12 +14,12 @@ import (
"net/http"
"time"
"github.com/go-chi/chi"
"github.com/go-chi/chi/_examples/versions/data"
v1 "github.com/go-chi/chi/_examples/versions/presenter/v1"
v2 "github.com/go-chi/chi/_examples/versions/presenter/v2"
v3 "github.com/go-chi/chi/_examples/versions/presenter/v3"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/render"
)

4
chi.go
View file

@ -9,8 +9,8 @@
// import (
// "net/http"
//
// "github.com/go-chi/chi"
// "github.com/go-chi/chi/middleware"
// "github.com/go-chi/chi/v5"
// "github.com/go-chi/chi/v5/middleware"
// )
//
// func main() {

2
go.mod
View file

@ -1,3 +1,3 @@
module github.com/go-chi/chi
module github.com/go-chi/chi/v5
go 1.16

View file

@ -4,7 +4,7 @@ import (
"net/http"
"path"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
// CleanPath middleware will clean out double slash mistakes from a user's request path.

View file

@ -11,7 +11,7 @@ import (
"strings"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestCompressor(t *testing.T) {

View file

@ -5,7 +5,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestContentCharset(t *testing.T) {

View file

@ -6,7 +6,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestContentEncodingMiddleware(t *testing.T) {

View file

@ -6,7 +6,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestContentType(t *testing.T) {

View file

@ -3,7 +3,7 @@ package middleware
import (
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
// GetHead automatically route undefined HEAD requests to GET handlers.

View file

@ -5,7 +5,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestGetHead(t *testing.T) {

View file

@ -6,7 +6,7 @@ import (
"net/http"
"net/http/pprof"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
// Profiler is a convenient subrouter used for mounting net/http/pprof. ie.

View file

@ -5,7 +5,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestXRealIP(t *testing.T) {

View file

@ -6,7 +6,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func maintainDefaultRequestID() func() {

View file

@ -4,7 +4,7 @@ import (
"fmt"
"net/http"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
// StripSlashes is a middleware that will match request paths with a trailing

View file

@ -7,7 +7,7 @@ import (
"strings"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestStripSlashes(t *testing.T) {

View file

@ -9,7 +9,7 @@ import (
"testing"
"time"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
var testContent = []byte("Hello world!")

View file

@ -5,7 +5,7 @@ import (
"net/http"
"strings"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
var (

View file

@ -5,7 +5,7 @@ import (
"net/http/httptest"
"testing"
"github.com/go-chi/chi"
"github.com/go-chi/chi/v5"
)
func TestURLFormat(t *testing.T) {