fix: #3620725 Drop the swagger-ui library assertion the removed requirement satisfied

Rajab Natshahrequested to merge
issue/horizonaid-3620725:3620725-remove-the-varbase into 1.0.x

Problem / Motivation

Follow-up to !66 (merged) on the same issue, which is still Active.

!66 (merged) removed drupal/varbase_api_base from require and was merged as ea5f3f5 before its pipeline finished. The pipeline then reported that the change leaves the repository inconsistent: the 🧩 (Drupal CMS) Install Horizon Aid site template job fails on 1.0.x.

❌ front-end libraries missing:
  web/libraries/swagger-ui/dist/swagger-ui-bundle.js
  web/libraries/swagger-ui/dist/swagger-ui.css

vardot/swagger-ui (^5.32.14) is required by varbase_api_base and by nothing else Horizon Aid requires, so removing that requirement correctly removes the library from the codebase. The front-end library assertion added in #3620353 still lists its two files, so the job now asserts a library the site template no longer has any reason to ship.

The Varbase lane is unaffected and stayed green: the Varbase profile requires varbase_api_base itself, so web/libraries/swagger-ui is still present there. Only the Drupal CMS lane, which builds cmssite/ from Drupal CMS plus the recipe, loses the library.

Proposed resolution

Drop the two swagger-ui entries from the $need list in the Drupal CMS install job, and update the comment above it that documented vardot/swagger-ui as one of the two self-placing packages. The remaining eight asserted files across five packages are unchanged.

Changes

.gitlab-ci.yml only:

           "web/libraries/jquery.fancytree/dist/skin-lion/ui.fancytree.min.css",
-          "web/libraries/swagger-ui/dist/swagger-ui-bundle.js",
-          "web/libraries/swagger-ui/dist/swagger-ui.css",
           "web/libraries/ckeditor5/plugins/media-embed/build/media-embed.js",

and, in the comment block above it:

-    #   Two of the six place themselves in ways worth knowing about, because
-    #   neither needs anything in this project's composer.json:
-    #     - vardot/swagger-ui is a drupal-library repackage of the Swagger UI
-    #       dist that replaces swagger-api/swagger-ui, which upstream publishes
-    #       as composer type `library` and composer/installers cannot place.
+    #   One of the five places itself in a way worth knowing about, because it
+    #   needs nothing in this project's composer.json:

GitLab computes this MR's diff against the merge base (9be5772), so the file list also shows the composer.json hunk from !66 (merged). That hunk is already on 1.0.x as ea5f3f5 and is byte-identical, so it is a no-op on merge and the MR reports as mergeable with no conflicts. The only change this MR actually lands is the .gitlab-ci.yml one above.

Verification

  • The file parses as GitLab CI YAML. Strict yaml.safe_load fails on !reference both before and after the change, identically, so that is pre-existing and not introduced here.
  • Nothing else in the repository references swagger-ui once the assertion and its comment are updated.

Issue

#3620725 Remove the Varbase API Base requirement, as the recipe is never applied and only drags its dependencies into every install

AI-Generated: Yes

Checkpoints:

  • File an issue
  • Addition/Change/Update/Fix
  • Testing to ensure no regression
  • Automated unit testing coverage
  • Automated functional testing coverage
  • UX/UI designer responsibilities
  • Readability
  • Accessibility
  • Performance
  • Security
  • Developer Documentation
  • User Guide Documentation
  • Reviewed by human
  • Code review by maintainers
  • Full testing and approval
  • Credit contributors
  • Review with the product owner
  • Release notes snippet
  • Release
Edited by Rajab Natshah

Merge request reports