From 672395b55e1f1117c03b13799128d0403312ec72 Mon Sep 17 00:00:00 2001 From: Benedikt Haas Date: Tue, 30 Jan 2024 16:23:29 +0100 Subject: [PATCH] apply relevant review points --- CARLOS_CHANGELOG.md | 16 ++++++++++++++++ FEATURES.md | 14 -------------- README.md | 4 ++-- Util/BuildTools/Setup.sh | 10 ++++++---- Util/Docker/Release.Dockerfile | 2 +- 5 files changed, 25 insertions(+), 21 deletions(-) create mode 100644 CARLOS_CHANGELOG.md delete mode 100644 FEATURES.md diff --git a/CARLOS_CHANGELOG.md b/CARLOS_CHANGELOG.md new file mode 100644 index 0000000000..b1bf024233 --- /dev/null +++ b/CARLOS_CHANGELOG.md @@ -0,0 +1,16 @@ +## Latest : 1.0.0 + +## 1.0.0 - Initial Release + +### Major changes + +* Created GitHub workflow and Dockerfile to automatically build Docker images +* Update to Ubuntu 22.04 and Python 3.10 for prerequisites image +* Update to Ubuntu 22.04 and Python 3.10 for release image +* Created `vulkan-base` Dockerfile to replace discontinued `nvidia/vulkan` images used for the release image +* Added health check to release image + +### Minor changes + +* Added `ping.py` script to PythonAPI to enable health checks +* Fix [aria2](https://aria2.github.io/) related issue diff --git a/FEATURES.md b/FEATURES.md deleted file mode 100644 index dc6a1c9745..0000000000 --- a/FEATURES.md +++ /dev/null @@ -1,14 +0,0 @@ -# Feature List -All changes are modifications to the original repository. - -## Core Features -- add GitHub workflow to automatically build Docker images -- update to Ubuntu 20.04 and Python3.10 for build image -- update to Ubuntu 22.04 and Python3.10 for release image -- ping.py script to check availability of the carla-simulator -- integrate and provide Docker health check - -## Minor Features -- use wget instead of aria2 for content download -- use private copy of fbxsdk -- use boost library from carla aws backup storage \ No newline at end of file diff --git a/README.md b/README.md index 60bce073a5..b9725852b0 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

> [!IMPORTANT] -> This repository is a minimal fork of the official [carla-simulator](https://github.com/carla-simulator/carla)! All modifications to the original repository are documented in [FEATURES.md](./FEATURES.md). +> This repository is a minimal fork of the official [carla-simulator](https://github.com/carla-simulator/carla)! All modifications to the original repository are documented in [CARLOS_CHANGELOG.md](./CARLOS_CHANGELOG.md). > [!TIP] > We recommend to use the *carla-simulator* as **simulation core** in our open, modular and scalable simulation framework **CARLOS**. @@ -19,7 +19,7 @@ > Here, it constitutes the central element of a simulation and handles all graphical and dynamic calculations in the individual simulation time steps. > [!NOTE] -> We set up a Continous Integration (CI) pipeline as [GitHub action](./github/workflows/docker.yml) to continously build Docker images for the `carla-simulator`, publicly available on [Docker Hub](https://hub.docker.com/r/rwthika/carla-simulator). +> We set up a Continous Integration (CI) pipeline as [GitHub workflow](./github/workflows/docker.yml) to continously build Docker images for the `carla-simulator`, publicly available on [Docker Hub](https://hub.docker.com/r/rwthika/carla-simulator). --- --- diff --git a/Util/BuildTools/Setup.sh b/Util/BuildTools/Setup.sh index 26e2b3570a..d5827efea9 100755 --- a/Util/BuildTools/Setup.sh +++ b/Util/BuildTools/Setup.sh @@ -91,10 +91,12 @@ for PY_VERSION in ${PY_VERSION_LIST[@]} ; do BOOST_PACKAGE_BASENAME=boost_${BOOST_VERSION//./_} log "Retrieving boost." - - # use boost backup instead of official release due to required verification - log "Using boost backup from aws carla-releases" - wget "https://carla-releases.s3.eu-west-3.amazonaws.com/Backup/${BOOST_PACKAGE_BASENAME}.tar.gz" || true + wget "https://boostorg.jfrog.io/artifactory/main/release/${BOOST_VERSION}/source/${BOOST_PACKAGE_BASENAME}.tar.gz" || true + # try to use the backup boost we have in Jenkins + if [[ ! -f "${BOOST_PACKAGE_BASENAME}.tar.gz" ]] ; then + log "Using boost backup" + wget "https://carla-releases.s3.eu-west-3.amazonaws.com/Backup/${BOOST_PACKAGE_BASENAME}.tar.gz" || true + fi log "Extracting boost for Python ${PY_VERSION}." tar -xzf ${BOOST_PACKAGE_BASENAME}.tar.gz diff --git a/Util/Docker/Release.Dockerfile b/Util/Docker/Release.Dockerfile index 0723f18497..590ca15f16 100644 --- a/Util/Docker/Release.Dockerfile +++ b/Util/Docker/Release.Dockerfile @@ -23,7 +23,7 @@ RUN echo "export PYTHONPATH=\$PYTHONPATH:$CARLA_PYAPI_PATH/carla/dist/$(ls $CARL USER carla WORKDIR /home/carla -HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=3 \ +HEALTHCHECK --interval=1s --timeout=5s --start-period=10s --retries=3 \ CMD python3 ./PythonAPI/util/ping.py # you can also run CARLA in offscreen mode with -RenderOffScreen