@@ -24,12 +24,24 @@ docker login ${CONTAINER_REGISTRY} -u "${GITHUB_USER}" --password-stdin
2424
2525### Building and pushing the Docker image
2626
27- Currently, this Dockerfile can be used to build one image :
27+ Currently, this Dockerfile can be used to build one the following images :
2828
2929* ` clang-format ` with C++ formatting tools. This image requires parameters:
30- * ` UBUNTU_VERSION ` for selection of Ubuntu release (recommended ` noble ` )
31- * ` CLANG_FORMAT_VERSION ` for [ clang-format] ( http://clang.llvm.org/docs/ClangFormat.html ) version
32- * ` PRE_COMMIT_VERSION ` for [ pre-commit] ( https://pre-commit.com/ ) version
30+ * ` UBUNTU_VERSION ` for selecting the Ubuntu release (recommended ` noble ` ).
31+ * ` CLANG_FORMAT_VERSION ` for the [ clang-format] ( http://clang.llvm.org/docs/ClangFormat.html ) version.
32+ * ` PRE_COMMIT_VERSION ` for the [ pre-commit] ( https://pre-commit.com/ ) version.
33+ * ` documentation ` with tools for building the rippled documentation. This image
34+ requires parameters:
35+ * ` UBUNTU_VERSION ` for selecting the Ubuntu release (recommended ` noble ` )
36+ * ` CMAKE_VERSION ` for the [ CMake] ( https://cmake.org/ ) version.
37+ * ` DOXYGEN_VERSION ` for the [ Doxygen] ( https://www.doxygen.nl/ ) version.
38+ * ` GCC_VERSION ` for the [ GCC] ( https://gcc.gnu.org/ ) version.
39+ * ` GRAPHVIZ_VERSION ` for the [ Graphviz] ( https://graphviz.org/ ) version.
40+ * ` prettier ` with tools for formatting JavaScript and TypeScript code. This
41+ image requires parameters:
42+ * ` NODE_VERSION ` for the [ Node.js] ( https://nodejs.org/ ) version.
43+ * ` NPM_VERSION ` for the [ npm] ( https://www.npmjs.com/ ) version.
44+ * ` PRETTIER_VERSION ` for the [ Prettier] ( https://prettier.io/ ) version.
3345
3446In order to build an image, run the commands below from the root directory of
3547the repository.
@@ -88,7 +100,6 @@ Ensure you've run the login command above to authenticate with the Docker
88100registry.
89101
90102``` shell
91- UBUNTU_VERSION=noble
92103NODE_VERSION=24.6.0
93104NPM_VERSION=11.5.2
94105PRETTIER_VERSION=3.6.2
@@ -102,7 +113,6 @@ docker buildx build . \
102113 --build-arg NODE_VERSION=${NODE_VERSION} \
103114 --build-arg NPM_VERSION=${NPM_VERSION} \
104115 --build-arg PRETTIER_VERSION=${PRETTIER_VERSION} \
105- --build-arg UBUNTU_VERSION=${UBUNTU_VERSION} \
106116 --tag ${CONTAINER_REGISTRY} /${CONTAINER_IMAGE}
107117```
108118
0 commit comments