mirror of
https://github.com/XRPLF/clio.git
synced 2025-11-20 11:45:53 +00:00
@@ -13,14 +13,36 @@ TMPDIR=${ROOT}/.cache/doxygen
|
|||||||
TMPFILE=${TMPDIR}/docs.log
|
TMPFILE=${TMPDIR}/docs.log
|
||||||
DOCDIR=${TMPDIR}/out
|
DOCDIR=${TMPDIR}/out
|
||||||
|
|
||||||
|
# Check doxygen is at all installed
|
||||||
if [ -z "$DOXYGEN" ]; then
|
if [ -z "$DOXYGEN" ]; then
|
||||||
# No hard error if doxygen is not installed yet
|
# No hard error if doxygen is not installed yet
|
||||||
cat <<EOF
|
cat <<EOF
|
||||||
|
|
||||||
WARNING
|
WARNING
|
||||||
-----------------------------------------------------------------------------
|
-----------------------------------------------------------------------------
|
||||||
'doxygen' is required to check documentation.
|
'doxygen' is required to check documentation.
|
||||||
Please install it for next time. For the time being it's on CI.
|
Please install it for next time.
|
||||||
|
|
||||||
|
Your changes may fail to pass CI once pushed.
|
||||||
|
-----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
EOF
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check version of doxygen is at least 1.12
|
||||||
|
version=$($DOXYGEN --version | grep -o '[0-9\.]*')
|
||||||
|
|
||||||
|
if [[ "1.12.0" > "$version" ]]; then
|
||||||
|
# No hard error if doxygen version is not the one we want - let CI deal with it
|
||||||
|
cat <<EOF
|
||||||
|
|
||||||
|
ERROR
|
||||||
|
-----------------------------------------------------------------------------
|
||||||
|
A minimum of version 1.12 of `which doxygen` is required.
|
||||||
|
Your version is $version. Please upgrade it for next time.
|
||||||
|
|
||||||
|
Your changes may fail to pass CI once pushed.
|
||||||
-----------------------------------------------------------------------------
|
-----------------------------------------------------------------------------
|
||||||
|
|
||||||
EOF
|
EOF
|
||||||
|
|||||||
@@ -3,6 +3,5 @@
|
|||||||
# This script is intended to be run from the root of the repository.
|
# This script is intended to be run from the root of the repository.
|
||||||
|
|
||||||
source .githooks/check-format
|
source .githooks/check-format
|
||||||
#source .githooks/check-docs
|
source .githooks/check-docs
|
||||||
|
|
||||||
# TODO: Fix Doxygen issue with reference links. See https://github.com/XRPLF/clio/issues/1431
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ WORKDIR /root
|
|||||||
ENV CCACHE_VERSION=4.10.2 \
|
ENV CCACHE_VERSION=4.10.2 \
|
||||||
LLVM_TOOLS_VERSION=18 \
|
LLVM_TOOLS_VERSION=18 \
|
||||||
GH_VERSION=2.40.0 \
|
GH_VERSION=2.40.0 \
|
||||||
DOXYGEN_VERSION=1.10.0
|
DOXYGEN_VERSION=1.12.0
|
||||||
|
|
||||||
# Add repositories
|
# Add repositories
|
||||||
RUN apt-get -qq update \
|
RUN apt-get -qq update \
|
||||||
|
|||||||
Reference in New Issue
Block a user