Fix Dependabot alerts: pin js-yaml to 4.3.2 - #35
Merged
Merged
Conversation
antora 3.1.15 depends on js-yaml ~4.1, and 4.1.1 is affected by GHSA advisories on quadratic CPU use in merge keys and !!omap (Dependabot alerts OpenIdentityPlatform#25-OpenIdentityPlatform#28). Override it to 4.3.2, the first release with all fixes; the 4.x API is unchanged and the site builds with the same known Antora errors as before.
maximthomas
approved these changes
Oct 1, 2026
This was referenced Oct 1, 2026
vharseko
added a commit
that referenced
this pull request
Oct 2, 2026
…nu (#30) Fixes #22 ## Changes - **`ROOT/modules/ROOT/pages/index.adoc`** (start page): - an "API Reference (Javadoc)" link at the end of the guide list of each of the four products; - a new "API Reference (Javadoc)" section (`#api-reference`) with *Products* (OpenDJ, OpenAM, OpenIG, OpenIDM) and *Libraries*: **OpenICF** and **Commons**, whose Javadoc was reachable only by URL. The links are root-relative (`/openam/apidocs/index.html`), because the Javadoc is not an Antora page but is copied into the site by `npm run copyApiDocs`. - **`supplemental-ui/partials/header-content.hbs`**: a divider and an "API Reference (Javadoc)" entry in the Projects menu, pointing to that section. Component navigation is not changed: the product release workflows replace `<product>/modules` (`rm -rf`) on every docs upload, so an entry added there in this repository would be lost; it would have to come from the product repositories. ## Verification Local Antora build of this branch (with `copyApiDocs`): - all six targets (`openam`, `opendj`, `openidm`, `openig`, `openicf`, `commons` `/apidocs/index.html`) exist in the generated site; - the menu entry resolves from every page, e.g. `./#api-reference` on the start page and `../../#api-reference` on `openam/admin-guide/`; - `lychee --offline`: no broken link on the start page; the site total is unchanged (45, all known and tracked); - no new Antora errors; - the branch is rebased onto `master` after #27 and #35, without conflicts. In CI, a missing `<dir>/apidocs/index.html` target is caught by the lychee check of #28; a renamed `#api-reference` anchor by its `--include-fragments` run proposed in #36.
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.
Closes the open Dependabot alerts #25–#28 (1 medium, 3 high): quadratic CPU consumption in
js-yamlmerge-key and!!omaphandling.Why an override
js-yaml@4.1.1comes in transitively throughantora@3.1.15, whose packages (@antora/playbook-builder,@antora/content-aggregator,@antora/ui-loader) requirejs-yaml ~4.1. All fixes land only in 4.2.0–4.3.2, so Dependabot cannot raise it within that range.package.jsonnow overridesjs-yamlto4.3.2;package-lock.jsonis updated accordingly. The version stays on the 4.x line, so the API Antora uses is unchanged. Moving toantora@3.2.0(which depends onjs-yaml ~5.4) would also clear the alerts, but it is a larger change to the site build and is left out of this PR.Verification
npm ls js-yaml— all three@antora/*consumers resolve to4.3.2 overridden.npm audit—found 0 vulnerabilities.npx antora antora-playbook.yml— exit 0; the 4 Antora errors it reports are the known ones from the product repositories (the same list as.github/build-baseline/antora-errors.txtin [#25] CI: build pull requests and make the site build reproducible #28), no new ones.