Skip to content

List sim's dependencies in the README, with why and from where - #93

Merged
slominskir merged 1 commit into
mainfrom
readme-dependencies
Nov 18, 2026
Merged

slominskir merged 1 commit into
mainfrom
readme-dependencies

Conversation

@slominskir-coding-agent

Copy link
Copy Markdown
Contributor

Summary

The README now has a Dependencies section, before Install, with two tables: what sim needs to run, and what it needs to build and test. Each row says what the dependency is used for, where it comes from, its license, and how it is maintained.

It is the record the SQAP asks for in section 6.1.1 ("Choice recorded: purpose, source, license, maintenance status"), written as an example for other products, and it tells someone installing sim what they need.

  • Versions stay in build.gradle, deps.yaml, compose.yaml and the Dockerfile, which the section links, so a version change does not touch the tables.
  • Maintenance status is as of November 2026. It records three things worth knowing:
    • UrlRewriteFilter is dormant: 5.1.3 (October 2023) is the latest release, and its repository last changed in February 2024.
    • MailHog is unmaintained: its last release was 1.0.1, in August 2020.
    • sim runs Wildfly 37.0.1, and the project's latest is 42.0.0.

README only: no change to the app, the database or the user guide.

Release notes

Nothing for users of the app. No upgrade steps.

Merging runs the DD workflow, which copies the README to the Docker Hub description. The README is 16 kB, under Docker Hub's 25 kB limit.

Checks

  • Every link the section adds returned 200 (four needed a second try after a timeout or a 429).
  • ./gradlew build: passes.
  • Licenses: read from each pinned version's POM on Maven Central (jsoup, UrlRewriteFilter, Hibernate, the Jakarta EE API, JSTL, Parsson, JUnit, the Smoothness weblib, the Oracle JDBC driver) or from the project's GitHub repository (Wildfly, Keycloak, Gradle, Spotless, PMD, SpotBugs and its Gradle plugin, MailHog, Zensical, the JLab images, the oracle-xe image scripts).
  • Maintenance status: each project's latest release and last push, from GitHub and Maven Central on 2026-11-18.
  • Not looked up, stated from general knowledge: the licenses of Java (GPL-2.0 with Classpath Exception), google-java-format (Apache-2.0) and nginx (BSD-2-Clause). Oracle Database is described only as "Commercial", and Oracle Database XE as "under Oracle's terms".
  • Not run: the integration tests and a browser check, since no behavior or page changed. Not checked: how the tables render on Docker Hub.

Decisions

  • The person asked what the "Dependency choices recorded" SQA element expects, and whether it needs its own document. The SQAP allows the README or the design specification; the person preferred the README, since the list also matters to people installing the software, and asked for this example.
  • Exact versions are left out of the tables, except where the README already tells an installer which to use (Java 17, Wildfly 37.0.1, Oracle 19), so the tables do not drift from the build files.
  • Dependencies of the build and tests are in a second table, so an installer reads only the first.
  • Not done here: what the record shows as open. sim has no Gradle lock file and no Dependabot configuration, and it depends on a dormant filter and a five-versions-old Wildfly. Each is a separate decision.

Prepared-by: Anthropic Claude Code:claude-fable-5-2

🤖 Generated with Claude Code

The README named Java, Wildfly and Oracle in its install steps and
linked deps.yaml, but nowhere said what sim depends on as a whole, what
each dependency is for, where it comes from, its license, or whether it
is still maintained. The SQAP asks for that record of each direct
dependency (6.1.1, "Choice recorded: purpose, source, license,
maintenance status"), and someone installing sim needs the same list.

A Dependencies section before Install now has two tables: what sim
needs to run, and what it needs to build and test. Versions stay in
build.gradle and the Compose files, which the section links, so a
version change does not touch the tables. Maintenance status is as of
November 2026: it records that UrlRewriteFilter is dormant, that
MailHog is unmaintained, and that Wildfly's latest release is 42 while
sim runs 37.

Co-Authored-By: Claude Fable 5.2 <[email protected]>
@slominskir-coding-agent slominskir-coding-agent Bot added the source::ai Prepared by an AI coding agent label Nov 18, 2026
@slominskir
slominskir merged commit fb761b2 into main Nov 18, 2026
7 checks passed
@slominskir
slominskir deleted the readme-dependencies branch November 18, 2026 17:02
slominskir pushed a commit to JeffersonLab/dtm that referenced this pull request Nov 18, 2026
The README named Java, Wildfly and Oracle in its install steps and
linked deps.yaml, but nowhere said what dtm depends on as a whole, what
each dependency is for, where it comes from, its license, or whether it
is still maintained. The SQAP asks for that record of each direct
dependency (6.1.1, "Choice recorded: purpose, source, license,
maintenance status"), and someone installing dtm needs the same list.
sim's README has the same section (JeffersonLab/sim#93).

A Dependencies section before Install now has two tables: what dtm
needs to run, and what it needs to build and test. Versions stay in
build.gradle, deps.yaml and the Dockerfile, which the section links.
Besides what sim also uses, it lists jLog, Apache POI, and the scripts
copied into the repository: jsTree 3.3.8 and three Flot plugins.
Maintenance status is as of November 2026: UrlRewriteFilter is dormant,
MailHog is unmaintained, Flot's last release was in 2014, and Wildfly's
latest release is 42 while dtm runs 37.

Co-Authored-By: Claude Fable 5.2 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

source::ai Prepared by an AI coding agent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant