Skip to content

Say under each SQA element's link what the link should be - #95

Merged
slominskir merged 1 commit into
mainfrom
element-evidence
Nov 18, 2026
Merged

slominskir merged 1 commit into
mainfrom
element-evidence

Conversation

@slominskir-coding-agent

Copy link
Copy Markdown
Contributor

Summary

The SQA Elements dialog takes a link for each element, and nothing said what to link. Under each link there is now a line from the SQAP that says what it should be, such as "The lock file; where the build tool has none, the build file or README that gives exact versions".

  • The SQAP gives each element of a product this line, its evidence (acc/iac/docs/sqap!24). SIM loads it with the elements into a new SQA_ELEMENT.EVIDENCE column, from SQAP revision draft 0e98a07 after 1.0.0.
  • The line runs on under the Note column, so it takes one or two lines; in the Link column alone it took three, and made the Full level's checklist a third taller.
  • The two elements SIM sets itself (Ratings recorded, Two maintainers) take no link and show no line.
  • container/oracle/sqa_elements_sql.py refuses an elements.json without the lines.
  • The revision changes nothing else of the elements. Their section links move to it, and so do the user guide's four links to section 4.3.
  • User guide: the Link field's description and a new paragraph in "Recording an element".

Release notes

Under each link in the SQA Elements dialog, SIM now says what the SQAP expects the link to be.

Upgrade. On an existing database, as SIM_OWNER, after 2.11.1_sqap_dependencies_merged.sql:

  1. container/oracle/upgrade/2.12.0_sqa_element_evidence.sql: adds SQA_ELEMENT.EVIDENCE, fills it for the 16 elements, moves their section links and revision to 0e98a07, and makes the column NOT NULL.

It must run after the 2.11.1 script, which removes the retired element that has no evidence. The script is named for 2.12.0, since this is a feature: rename it if it ships in another version.

Checks

  • ./gradlew build: passes.
  • uv run --locked zensical build --strict: no issues.
  • ./gradlew integrationTest against a new stack built from this branch (on ports of its own, since another stack held the defaults): 93 tests, 0 failed, before and after the last style change. The new PagesIT.elementsSayWhatTheirLinkPointsTo checks that every row has a line in the Link column, the text of one, and the footer.
  • Upgrade script: on that stack I dropped the column and set the 16 rows back to revision 19bcfba with the 2.11.1 script's updates, then ran the new script: 16 rows updated, each identical to a new database's, and the column NOT NULL.
  • Browser (headless Chromium, logged in as tbrown, 1400 px wide): added a product, rated it Full, and opened its SQA Elements dialog. All 14 recordable elements show their line under the link, on one or two lines; the two SIM sets show none; no console errors.
  • docker compose logs sim: the only errors come from the tests' rejection cases.
  • Not checked: the dialog logged out, or in a narrow window; the code.jlab.org links in a browser.

Decisions

  • The person found the four dependency elements confusing to fill in. Of three options (say what to link for each row; let workflows and repositories provide more rows; merge rows in the SQAP), they chose the first, in the SQAP and then here.
  • The line is under the link, not under the element's label: it describes the link. It is not the link's placeholder, which would vanish on typing and cannot hold 120 characters.
  • Not done: the Repositories and Workflows pages, which also take a link for each element they provide.
  • The Test plan line says "not the pipeline or the tests", following acc/iac/docs/sqap!23, which is still open. If that changes, the line changes with the next SQAP revision SIM loads.

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

🤖 Generated with Claude Code

The SQA Elements dialog takes a link for each element, and nothing said
what to link: for "Test plan", the pipeline, the tests or a document;
for the four elements about dependencies, which of the build file, the
lock file and the README. The SQAP now gives each element of a product
a line of evidence, what its record links to (acc/iac/docs/sqap!24).

SIM loads that line with the elements, from SQAP revision draft 0e98a07
after 1.0.0, into a new SQA_ELEMENT.EVIDENCE column, and the dialog
shows it under the link, such as "The lock file; where the build tool
has none, the build file or README that gives exact versions". It runs
on under the note, so that it takes a line or two, not three. The two
elements SIM sets itself take no link and show no line. The loader
refuses an elements.json without the lines.

The revision changes nothing else of the elements, so their section
links and the user guide's four links to section 4.3 move to it, and
container/oracle/upgrade/2.12.0_sqa_element_evidence.sql adds the
column and the lines to an existing database.

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 f3d9040 into main Nov 18, 2026
7 checks passed
@slominskir
slominskir deleted the element-evidence branch November 18, 2026 17:19
@slominskir-coding-agent slominskir-coding-agent Bot mentioned this pull request Nov 18, 2026
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