Skip to content

CASSANDRA-21315: Upgrade docs build stack to Antora 3.1 and Node.js 24 LTS #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pmcfadin wants to merge 1 commit into
base: trunk
Choose a base branch
from
+11 −18
Open

CASSANDRA-21315: Upgrade docs build stack to Antora 3.1 and Node.js 24 LTS #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions site-content/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ RUN ln -s /usr/bin/python3 /usr/bin/python
# Install Node.js for Antora (documentation generation)
RUN sh -c '\
set -ex ;\
NODE_VERSION="v20.16.0" ;\
NODE_VERSION="v24.14.1" ;\
NODE_PLATFORM=x64 ;\
[ $(uname -m) = "aarch64" ] && NODE_PLATFORM=arm64 ;\
NODE_VERSION_SHAS="c30af7dfea46de7d8b9b370fa33b8b15440bc93f0a686af8601bbb48b82f16c0 1d9929e72f692179f884cd676b2dfabd879cb77defa7869dc8cfc802619277fb" ;\
NODE_VERSION_SHAS="84d38715d449447117d05c3e71acd78daa49d5b1bfa8aacf610303920c3322be 71e427e28b78846f201d4d5ecc30cb13d1508ca099ef3871889a1256c7d6f67e" ;\
NODE_TAR="node-${NODE_VERSION}-linux-${NODE_PLATFORM}.tar.xz" ;\
wget -q "https://nodejs.org/dist/${NODE_VERSION}/${NODE_TAR}" --no-check-certificate ;\
NODE_SHA="$(sha256sum ${NODE_TAR} | cut -d" " -f1)" ;\
Expand All @@ -77,9 +77,9 @@ RUN sh -c '\

CMD [ "npm", "--version" ]

# Use npm to install Antora globally, and antora-lunr for site search, and js-yaml to load YAML files
RUN npm i -g @antora/cli@2.3 @antora/site-generator-default@2.3 @djencks/asciidoctor-openblock
RUN npm i -g antora-lunr antora-site-generator-lunr
# Use npm to install Antora globally, with Antora 3 search extension and AsciiDoc extensions
RUN npm i -g @antora/cli@3.1.14 @antora/site-generator@3.1.14 @djencks/asciidoctor-openblock
RUN npm i -g @antora/lunr-extension
RUN npm i -g live-server

# Create the build user and make it part of the password-less sudo group
Expand Down
14 changes: 1 addition & 13 deletions site-content/docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ generate_site_yaml() {
render_site_content_to_html() {
pushd "${CASSANDRA_WEBSITE_DIR}/site-content" > /dev/null
log_message "INFO" "Building the site HTML content."
antora --generator antora-site-generator-lunr site.yaml
antora site.yaml
log_message "INFO" "Rendering complete!"
popd > /dev/null
}
Expand Down Expand Up @@ -325,12 +325,6 @@ run_preview_mode() {
if [ "${COMMAND_BUILD_SITE}" != "run" ]
then
generate_site_yaml

export DOCSEARCH_ENABLED=true
export DOCSEARCH_ENGINE=lunr
export NODE_PATH="$(npm -g root)"
export DOCSEARCH_INDEX_VERSION=latest

render_site_content_to_html
fi

Expand Down Expand Up @@ -444,12 +438,6 @@ fi
if [ "${COMMAND_BUILD_SITE}" = "run" ]
then
generate_site_yaml

export DOCSEARCH_ENABLED=true
export DOCSEARCH_ENGINE=lunr
export NODE_PATH="$(npm -g root)"
export DOCSEARCH_INDEX_VERSION=latest

render_site_content_to_html
prepare_site_html_for_publication
fi
Expand Down
5 changes: 5 additions & 0 deletions site-content/site.template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ output:
clean: true
dir: ./build/html

antora:
extensions:
- require: '@antora/lunr-extension'
index_latest_only: true

asciidoc:
attributes:
idprefix: ''
Expand Down