Skip to content

docs: liveness signals in README + public ROADMAP #3002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vishr merged 2 commits into from
Jun 13, 2026
+56 −0
Merged

docs: liveness signals in README + public ROADMAP #3002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c5f412
docs: add liveness signals to README and a public ROADMAP
vishr Jun 13, 2026
904126c
docs: fix review findings in README/ROADMAP
vishr Jun 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Latest release](https://img.shields.io/github/v/release/labstack/echo?style=flat-square&label=release&color=00afd1)](https://github.com/labstack/echo/releases)
[![Last commit](https://img.shields.io/github/last-commit/labstack/echo/master?style=flat-square)](https://github.com/labstack/echo/commits/master)
[![Sourcegraph](https://sourcegraph.com/github.com/labstack/echo/-/badge.svg?style=flat-square)](https://sourcegraph.com/github.com/labstack/echo?badge)
[![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/labstack/echo/v5)
[![Go Report Card](https://goreportcard.com/badge/github.com/labstack/echo?style=flat-square)](https://goreportcard.com/report/github.com/labstack/echo)
Expand All @@ -11,6 +13,8 @@

High performance, extensible, minimalist Go web framework.

Echo is built on Go's standard `net/http` — and interoperates with it via `echo.WrapHandler` / `echo.WrapMiddleware` — adding the parts the standard library leaves to you: a fast radix-tree router, request binding (with a pluggable validator), a deep middleware ecosystem, and centralized error handling. Actively maintained, with `v5` as the current release line (see badges above for the latest version and most recent commit).

* [Official website](https://echo.labstack.com)
* [Quick start](https://echo.labstack.com/docs/quick-start)
* [Middlewares](https://echo.labstack.com/docs/category/middleware)
Expand Down Expand Up @@ -53,6 +57,8 @@ Click [here](https://github.com/sponsors/labstack) for more information on spons
- See [API_CHANGES_V5.md](./API_CHANGES_V5.md) for public API changes between `v4` and `v5`, notes on upgrading.
- Echo `v4` is supported with **security*** updates and **bug** fixes until **2026-12-31**

See [ROADMAP.md](./ROADMAP.md) for where Echo is heading and the version support policy.

### Installation

```sh
Expand Down
50 changes: 50 additions & 0 deletions ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Echo Roadmap

> **DRAFT** — this is a starting point for maintainers to edit, not a commitment.
> Dates and priorities are owned by the Echo team. Open a discussion to propose changes.

This document exists so the community can see where Echo is heading. Echo is
**actively maintained**. We publish releases regularly across two supported
lines — see [README](./README.md) badges for the latest version and most recent commit.

## Version policy

| Line | Status | Support |
|------|--------|---------|
| `v5` | **Current** (since 2026-01-18) | New features, fixes, and improvements. |
| `v4` | Maintenance / LTS | **Security and bug fixes until 2026-12-31.** No new features. |

Upgrading from v4? See [API_CHANGES_V5.md](./API_CHANGES_V5.md).

Echo supports the **latest four Go major releases** and may work with older versions.

## Now (in progress)

- Stabilizing the `v5` API surface through point releases.
- Documentation catch-up for v5 behavior changes (e.g. CORS / `RouteNotFound`
behavior on groups — see #2950).
- Triaging and reducing the open issue / PR backlog.

## Next (under consideration)

These are frequently-requested items being discussed. Inclusion here is **not** a
commitment — each still needs design agreement before implementation:

- **Automatic `HEAD` for `GET` routes** (#2895; see #2949) — opt-in, likely via an
`OnAddRoute` hook so users keep control.
- **Rate limiter response metadata** — expose `Retry-After` / remaining quota
through the store interface (#2961).
- **Real-IP / `Forwarded` header handling** improvements (#2744).
- **Proxy middleware** authorization-header handling (#2787).

## Later / exploratory

- Continued alignment with the Go standard library (`net/http`, `slog`).
- Reducing third-party surface where the stdlib now covers the need.

## How to influence the roadmap

- **Discuss before large PRs** — open a [Discussion](https://github.com/labstack/echo/discussions)
or issue so we can agree on the design first.
- 👍 reactions on issues help us gauge demand.
- See [README → Contribute](./README.md#contribute) for contribution guidelines.
Loading