Skip to content

Commit c979544

Browse files
committed
Review feedback
1 parent aa7a8c1 commit c979544

File tree

3 files changed

+24
-12
lines changed

3 files changed

+24
-12
lines changed

docker/debian/Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
# contain dynamic values supplied via an argument. We are using GCC image rather
44
# than the official Debian package to access the latest versions, built by the
55
# GCC team specifically for this Debian release. For build images using official
6-
# distribution packages, see Ubuntu. We set the GCC version to "invalid" to
6+
# distribution packages, see Ubuntu. We set the GCC version to "undefined" to
77
# satisfy the syntax checker, as it checks if the `FROM` command has a valid
88
# image, even though it is not used for Clang.
99
ARG DEBIAN_VERSION
10-
ARG GCC_VERSION=invalid
10+
ARG GCC_VERSION=undefined
1111
ARG BASE_IMAGE=gcc:${GCC_VERSION}-${DEBIAN_VERSION}
1212
FROM ${BASE_IMAGE} AS gcc-src
1313

docker/tools-rippled/Dockerfile

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# This argument must be defined before the base image, so it can be used in the
2-
# prettier image, which does not derive from the base image, below.
3-
ARG NODE_VERSION
2+
# prettier image, which does not derive from the base image, below. We set both
3+
# the Node and Ubuntu versions to "undefined" to satisfy the syntax checker, as
4+
# it checks if the `FROM` command has a valid image, even when it is not used.
5+
ARG NODE_VERSION=undefined
6+
ARG UBUNTU_VERSION=undefined
47

58
# ====================== BASE IMAGE ======================
6-
ARG UBUNTU_VERSION
79
FROM ubuntu:${UBUNTU_VERSION} AS base
810

911
# Use Bash as the default shell for RUN commands, using the options
@@ -121,7 +123,7 @@ ENV HOME=/root
121123
WORKDIR ${HOME}
122124

123125
# ====================== PRETTIER IMAGE ======================
124-
# Note, we do not install a compiler here.
126+
# Note, this image does not inherit from the base image.
125127

126128
FROM node:${NODE_VERSION}-alpine AS prettier
127129

docker/tools-rippled/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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

3446
In order to build an image, run the commands below from the root directory of
3547
the repository.
@@ -88,7 +100,6 @@ Ensure you've run the login command above to authenticate with the Docker
88100
registry.
89101

90102
```shell
91-
UBUNTU_VERSION=noble
92103
NODE_VERSION=24.6.0
93104
NPM_VERSION=11.5.2
94105
PRETTIER_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

Comments
 (0)