From d10cbf41f61b1d3d420df80a3d39e3d61915259f Mon Sep 17 00:00:00 2001 From: Hardy Nguyen Date: Mon, 20 Jul 2026 13:33:15 +0000 Subject: [PATCH] docs: overhaul README to track version verification log --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e69fa93..6b56abb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # http-server-e2e -Provide E2E test cases for @pkg-nec/http-server package + +An independent, rigorous E2E test suite for `@pkg-nec/http-server`. + +**Purpose:** To verify that new upstream versions work flawlessly, prevent regressions, and transparently track known behavior changes over time. + +## Version Verification Log + +### v14.3.1 & v14.3.0 +* **Status:** Verified Stable. +* **Details:** All core E2E tests pass flawlessly with no regressions detected. + +### v14.2.0 +* **Status:** Verified Stable (with known behavior change). +* **Details:** Documented a change in the `html-encoding-sniffer` package. It was upgraded to conform to the WHATWG Encoding Standard, resulting in `iso-8859-1` being correctly aliased to `windows-1252`. Our test suite was updated to strictly verify this compliance across legacy and modern versions. + +### v14.1.4 & v14.1.2 +* **Status:** Verified Baseline Stability. +* **Details:** Established robust testing for core features: + * **minimist:** CLI flag parsing, CORS, caching, `--no-dotfiles`, and `--tls` alias. + * **portfinder:** Fallback port allocation when default ports are blocked. + * **Architecture:** Built with strict process isolation and dynamic OS-level port allocation to prevent `EADDRINUSE` race conditions during parallel test execution. + +## Running the Suite + +To run the test suite locally against a specific upstream version: + +```bash +# 1. Clone the repository +git clone +cd http-server-e2e + +# 2. Install a target version of the server +npm install @pkg-nec/http-server@14.3.1 + +# 3. Execute the Tap-based parallel test suite +npm test +```