Repository navigation
Release 2.5.0: jbang, a skill for coding agents, and the documentation at one address - #442
Merged
Merged
Conversation
…n at one address Every pom.xml from 2.5.0-SNAPSHOT to 2.5.0; the README and chapters 2 and 9 of the manual install and run 2.5.0, with the output of the archive and the image built from this commit. The schemas' $id names v2.5.0 already, and the base images are the newest patch already. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…s run of release.yml printed them Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
11 tasks done
ssegura
added a commit
that referenced
this pull request
Nov 10, 2026
….0-SNAPSHOT (#444) **Related:** None. This is the step after the 2.5.0 release, the last of `docs/ci.md`'s release steps. ## What you can do now that you could not before Tell a build of `master` from the release. `v2.5.0` is tagged and [published](https://github.com/isa-group/RESTest/releases/tag/v2.5.0), and its modules are on Maven Central. From here on, a build of `master` says `RESTest 2.6.0-SNAPSHOT` in `restest version` and in every `report.json`, so a report produced by code that came after 2.5.0 is never taken for one produced by 2.5.0 itself. ## Try it yourself ```bash git clone --quiet -b chore/2.6.0-snapshot https://github.com/isa-group/RESTest.git restest-snapshot && cd restest-snapshot ./mvnw -q install -DskipTests ./restest version grep -h '"\$id"' schemas/*.json ``` Real output, from a fresh clone of this branch on 10 November (the Java line is your own): ``` RESTest 2.6.0-SNAPSHOT Java 25.0.4.1 (Eclipse Adoptium), Mac OS X 27.0.1 aarch64 "$id": "https://raw.githubusercontent.com/isa-group/RESTest/v2.6.0/schemas/dictionary.schema.json", "$id": "https://raw.githubusercontent.com/isa-group/RESTest/v2.6.0/schemas/campaign.schema.json", ``` ## How it works The version lives in the build files, and the tool reads it from there. `-SNAPSHOT` is how Maven writes "on the way to this version, not yet published". The tag `v2.5.0` keeps the commit that says 2.5.0; `master` moves on to the next version and drops the `-SNAPSHOT` again when that one is released. The JSON Schemas of a dictionary and a plan name the release they describe in their `$id`, the address each is published at. On `master` that is the release being prepared, `v2.6.0`, which `PublishedSchemasTest` requires to be no older than the snapshot. ## What changed in the code No Java code and no page changed. - The ten `pom.xml`, from `2.5.0` to `2.6.0-SNAPSHOT`, with `./mvnw versions:set`. - `schemas/campaign.schema.json` and `schemas/dictionary.schema.json`: `$id` from `…/v2.5.0/…` to `…/v2.6.0/…`. ## Evidence - [x] **Tests:** `./mvnw clean install` green on this branch: 4,981 tests, 0 failures, BUILD SUCCESS in 2 min 37 s. Among them are the 76 tests of `PublishedSchemasTest`. On [CI](https://github.com/isa-group/RESTest/actions/runs/42876875507)'s first attempt two rows failed, each in a test this pull request does not touch, and both were re-run: - *Java 26 on ubuntu-latest*, in `EngineFaultsTest.a_redirection_nowhere_is_a_wait_for_a_connection`, which follows a redirection to a port that accepts the connection and never answers, with a read timeout of 300 ms, and expects a wait for a connection: it got a wait for a reply, the timeout having run out in a part of the exchange the engine counts as the reply. - *Java 25 on macos-latest*, in `FuzzingFindsWhatNominalMissesTest.the_awkward_values_are_what_find_it`, which expects the empty search term among the awkward values of a run of 1,200 requests: with seed `1749106978450864122`, its 120 awkward values did not include it, though the test's comment says that size reaches it every time. Both depend on timing or chance, as `RunLoopTest.an_operation_told_to_wait_is_skipped` did in #442; they are put right in a pull request of their own. - [x] **Architecture tests:** unchanged, none weakened. - [x] **Mutation score:** not touched. - [x] **Per-request overhead:** not touched. - [x] **Smoke run:** not touched. - [x] **Idle time:** not touched. - [x] **Artefact:** the installation of 2.5.0 was tried from outside on 10 November, as the README gives it, with no one signed in to GitHub, to the registry or to Maven Central: - **Homebrew:** publishing the release started [`homebrew.yml`](https://github.com/isa-group/RESTest/actions/runs/42871411688), and all six of its jobs are green. It wrote `restest 2.5.0` into `isa-group/homebrew-tap`, with the checksum `checksums_sha256.txt` gives `restest-2.5.0.tgz`, and installed it from there on macOS and on Linux, 628 MB and 824 MB as chapter 2 of the manual says. `brew install isa-group/tap/restest` on a Mac with neither the tap nor RESTest installed it too, with an `openjdk@21` of its own, and `restest version` printed `RESTest 2.5.0` on `Java 21.0.13.0.3 (Homebrew)`. - **jbang:** publishing the release started [`jbang.yml`](https://github.com/isa-group/RESTest/actions/runs/42871411661), and all six of its jobs are green. The catalog names `es.us.isa.restest:restest-cli:2.5.0`, and `jbang --fresh restest@https://isa-group.github.io/jbang-catalog/jbang-catalog.json version`, with a jbang folder of its own, printed `RESTest 2.5.0`. Its `check` jobs count 38 to 39 MB of libraries on Linux and macOS and 37 on Windows, what they counted on 1 November when chapter 2 was written, so its 37 MB stay. - **The image:** `ghcr.io/isa-group/restest:2.5.0`, pulled with an empty Docker configuration, printed `RESTest 2.5.0` on Java 21.0.13. Chapter 2's `restest` script, written into a `HOME` of its own, ran a run against nothing that ended with `3` and left `report.json` and `report.html` in the folder, owned by the user. The registry gives `:latest` the same digest, `sha256:3e72646c…`. - **The archive:** `restest-2.5.0.tgz` and `checksums_sha256.txt`, downloaded with `curl`. `shasum -a 256 -c` answered `OK`, `restest version` printed `RESTest 2.5.0`, and `skills/restest/SKILL.md` is in it. - **The source:** `git clone --branch v2.5.0`, with no credential helper, followed by `./mvnw -q install -DskipTests` printed `RESTest 2.5.0`. - **Maven Central:** `https://repo1.maven.org/maven2/es/us/isa/restest/restest-cli/2.5.0/` answers, and all 128 files of the eight modules are there. A project that depends on `es.us.isa.restest:restest-cli:2.5.0`, resolved from Central into an empty local repository, got 71 jars, the same names and the same bytes as the release archive's `lib/`, and `restest version` run from them printed `RESTest 2.5.0`. - **The documentation site:** publishing the release started [`documentation-site.yml`](https://github.com/isa-group/RESTest/actions/runs/42871411673), and all three of its jobs are green. https://isa-group.github.io/restest-site/llms.txt now names 2.5.0, and the page for coding agents the README sends an agent to answers. ## Decisions taken - **2.6.0, not 2.5.1:** the next release is meant to add features, which semantic versioning makes a minor version. - **No release step changes.** All eight of `docs/ci.md`'s steps worked for 2.5.0 as they are written, including the first publication of the jbang catalog for a release and the documentation site's move to it, so neither that page nor an ADR is touched. ## Open questions None. --- - [x] Targets `master` - [x] English throughout, including comments and test names - [x] The hard rules in `AGENTS.md` hold - [x] Nothing from "Out of scope" in `docs/DESIGN.md` without explicit approval 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
7 of 10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related: None. This is the release of 2.5.0, with what
masterholds on 10 November: #432 to #441. This pull request is merged before the tagv2.5.0, which goes on its merge commit.What you can do now that you could not before
brew install isa-group/tap/restest;jbang app install restest@https://isa-group.github.io/jbang-catalog/jbang-catalog.json, new in this version, with no Java installed first;docker run ghcr.io/isa-group/restest:2.5.0;skills/restest/SKILL.md(RESTest skill #437), and the page for coding agents gives the sentence to hand one, the same in the README (Ask a coding agent to follow the page for coding agents on the documentation site, in the same words everywhere #441);report.htmlas a real run of the clinic draws it, light and dark, with that run'sreport.jsonbeside it (See report.html in the manual as a real run of the clinic shows it, in light and dark, with that run's report.json beside it #440);http.serverdoes, gets a reply read for every request (Get a reply to every request from an API that answers in HTTP/1.0, as Python's http.server does #436).Try it yourself
From a clean clone, with only Java and git:
Below is the real output, from a fresh clone of this branch on 10 November; the Java line will be your own. Nothing listens on port 1, so the run ends with
3, and it still writes both files; the archive carries the skill:With Docker as well, the image is built from the same clone, as the release builds it:
What the tag will leave on the Central Portal, laid out from the same clone:
How it works
The version.
-SNAPSHOTis how Maven writes "on the way to this version", and this pull request removes it from everypom.xml. After the merge, the tagv2.5.0on the merge commit starts the release workflow (docs/ci.md):centraljob; the Portal validates them and publishes nothing;A maintainer publishes the deployment on the Portal before publishing the release. Publishing the release starts the Homebrew workflow, which writes 2.5.0 into the tap, the jbang workflow, which writes it into the catalog, and the documentation site's, which moves the site on to 2.5.0. Before the tag, the documentation site is built by hand from
master, so that a tag the site cannot build is never pushed.The base images. Step 1 of every release moves the
Dockerfile's two base images to the newest patch; they are the newest already, so theDockerfiledoes not change, nor the Java the image prints.The pages. The README and chapters 2 and 9 of the manual name the version to install, and now name 2.5.0. Every other page was written for 2.5.0 as each change landed, from #432 to #441. Those that give a minimum version (the skill's "2.4.0 or later"), speak of a past release, or name the version the manual's kept run was made with (chapter 4's, 2.4.0) stay as they are.
What changed in the code
No Java code changed, and nothing under
src/.pom.xml, from2.5.0-SNAPSHOTto2.5.0, ten files. The JSON Schemas'$idalready namesv2.5.0since Tell a build of master from the 2.4.0 release: master moves on to 2.5.0-SNAPSHOT #432.README.md: the Docker command runs2.5.0.docs/manual/02-installing.md: Homebrew's and jbang'srestest version, Docker, the archive, the checksums, the source and Updating name 2.5.0. The Docker and archive outputs are those above, unchanged but for the version. Homebrew's and jbang's lines and sizes are what this pull request's run ofrelease.ymlprinted, asdocs/ci.mdasks:check-homebrewinstalled 628 MB on macOS and 824 MB on Ubuntu (625 and 823 before) and printedJava 21.0.13.0.3 (Homebrew), Mac OS X 26.7.2 aarch64;check-jbangstarted RESTest on Java 27.0.1.0.2, where the page said27, with 636 MB of Javas, where it said some 600. jbang's libraries, 37 MB, stay as they are:check-jbangcounts the sources and the Javadoc Maven Central gets, which jbang does not download, and the published release's run ofjbang.ymlis what they are checked against.docs/manual/09-exit-codes-and-ci.md: the workflow fetches and runs the 2.5.0 archive.Evidence
./mvnw verifyis green atedfb1510, with version 2.5.0: 4,981 tests, 0 failures, BUILD SUCCESS in 2 min 36 s. 162 of them are the architecture and documentation rules,PublishedSchemasTestamong them, which on a release requires the schemas'$idto name it; they pass again with chapter 2's sizes. The first push's Release run is green,centralandpublishskipped, as on every pull request. On the second push, CI's Java 26 on ubuntu-latest failed on its first attempt inRunLoopTest.an_operation_told_to_wait_is_skipped, which countedgetPet's wait twice where it expects once: a wait the API asks for that lasts past the end of the budget ends at the budget's end, and a request sent at that very moment is let through and refused again, beginning a second wait. The row passed when re-run, with the two rows the failure had cancelled, and every check is green. Nothing undersrc/changes here; the race is put right in a pull request of its own, after this release.src/changed.check-restest.sh 2.5.0passes on both the archive and the image built here, every checkok:--launcheronrestest-2.5.0/bin/restest, and--image restest:2.5.0, built again without Docker's cache.dist/central.shpasses on the build above;restest-cli's POM names the 70 libraries the archive'slib/carries besiderestest-cliitself.Decisions taken
report.htmlnorFaultCategory.javachanged since v2.4.0, and See report.html in the manual as a real run of the clinic shows it, in light and dark, with that run's report.json beside it #440, which added the manual's kept run, says they are made again only when the page or the kinds of fault change. Chapter 4 keeps naming 2.4.0, the version that run was made with.docs/ci.mdsays.Open questions
None. After the merge, each step taken by a maintainer: the documentation site built by hand from
master; the tagv2.5.0on the merge commit, and the approval of thecentraljob; the notes in the draft; the deployment published on the Central Portal, then the release; the installation commands tried from outside; and the pull request that movesmasterto2.6.0-SNAPSHOT.masterAGENTS.mdhold🤖 Generated with Claude Code