Repository navigation
Link draft SQA elements to the SQAP's source at their revision - #91
Merged
Merged
Conversation
Each element in the SQA Elements dialog linked to its section on the SQAP's website under "latest", which redirects to the last released revision, 1.0.0. SIM loads a draft revision (8905d54 after 1.0.0), whose tables have rows 1.0.0 lacks, such as Two maintainers, and whose section 6.1.5, holding the four dependency elements, 1.0.0 doesn't have at all, so links landed on tables without their element or at the top of the page. sqa_elements_sql.py now links a draft's elements to the plan's source on code.jlab.org at the draft's commit, where GitLab gives each heading the website's anchor; a released revision still links to its own folder on the website. The dialog's SQAP section 4.4 link follows the loaded elements instead of always "latest". 03_sqa_elements.sql is regenerated, and existing databases need container/oracle/upgrade/2.11.1_sqap_draft_section_links.sql. Co-Authored-By: Claude Opus 5.5 <[email protected]>
The Risk & SQA Assessment dialog's "SQAP section 4.3" link and the user guide's links to 4.3.1 to 4.3.4 still went to the SQAP website's "latest", the released 1.0.0, which has a 4.3 but none of those subsections. The dialog's link now follows the loaded elements, as the SQA Elements dialog's 4.4 link does. The user guide, published with each release, names the revision this release loads (8905d54) and says why it is on code.jlab.org. Co-Authored-By: Claude Opus 5.5 <[email protected]>
slominskir
approved these changes
Nov 18, 2026
slominskir
pushed a commit
that referenced
this pull request
Nov 18, 2026
The SQAP (acc/iac/docs/sqap!22, revision 19bcfba) merged "Dependencies on other ACS products recorded in the build files or README" into "Dependencies recorded in the build files or README: acquired software with its versions, and other ACS products, including their servers, schemas and web services", and named the group of dependency elements Dependencies instead of Acquired Software. A checklist now asks once for the record of a product's dependencies, and shows it with the other dependency elements; acs-dependencies-recorded is retired. 03_sqa_elements.sql is regenerated: 16 elements. Existing databases need container/oracle/upgrade/2.11.1_sqap_dependencies_merged.sql, which sets each element's row to what a new database loads, moves a status recorded for the retired element to dependencies-recorded where a product has none there, after listing the products that recorded the two differently, and deletes the retired element. It also sets the section links #91 changed, so it replaces that pull request's unreleased 2.11.1_sqap_draft_section_links.sql: one script for the release, with no order to get wrong. The user guide's links to section 4.3 name the new revision. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Merged
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.
Summary
In the SQA Elements dialog, each element's § link went to the SQAP website under
latest. The site's_redirectssends/latest/*to/v1.0.0/, the last released revision. SIM loads a draft revision (draft 8905d54 after 1.0.0), so many links pointed at text that doesn't have the element:#615-required-sqa-elements, but v1.0.0 has no section 6.1, so they land at the top of section 6.Now:
sqa_elements_sql.pylinks a draft's elements to the SQAP's source on code.jlab.org at the draft's commit, such ashttps://code.jlab.org/acc/iac/docs/sqap/-/blob/8905d54/docs/04-software-development-life-cycle.md#446-maintenance. GitLab gives each heading the same anchor as the website. I checked every anchor these links use with GitLab's Markdown API:#441-requirements,#446-maintenance,#615-required-sqa-elements,#44-life-cycle-stages,#43-software-control-levelsand#431-ops-impactto#434-recording-the-control-level./v2.0.0/…), so these links move to the website once SIM loads SQAP 2.0.0 (Load the released SQAP revision's SQA elements in place of the draft's #79).latest.…/-/blob/8905d54/docs/04-software-development-life-cycle.md#431-ops-impactand so on, and says why the links go to code.jlab.org. When SIM loads another SQAP revision (Load the released SQAP revision's SQA elements in place of the draft's #79), these four links need updating with it.03_sqa_elements.sqlis regenerated, with onlySECTION_URLchanging. The user guide says where the links go.Release notes
Oracle DB Migration Notes
Run on a database at 2.11.0, as
SIM_OWNER:container/oracle/upgrade/2.11.1_sqap_draft_section_links.sql: updatesSQA_ELEMENT.SECTION_URLof the 17 elements.Checks
./gradlew build: passes../gradlew integrationTestagainst a new stack built from this branch: 92 tests, 0 failed. The newPagesIT.elementsLinkToTheSqapRevisionTheyCameFromchecks Two maintainers' link, the §4.4 link and the §4.3 link against the revision named in the dialog's footer. I reran the tests after the second commit.SECTION_URLback to what 2.11.0 loads. The new test then failed:expected https://code.jlab.org/…/8905d54/…#446-maintenance but was https://pages.jlab.org/…/latest/…#446-maintenance.uv run --locked zensical build --strict: no issues.docker compose logs sim: the only errors come from the tests' rejection cases.8905d54.Decisions
latestredirects to v1.0.0. They chose to link the draft's source at its revision until SQAP 2.0.0 is released (sqap!12) and SIM loads it (Load the released SQAP revision's SQA elements in place of the draft's #79), over waiting for that release.Prepared-by: Anthropic Claude Code:claude-opus-5-5
🤖 Generated with Claude Code