From f62e36dc94d3ee82fa6cbb1c07f9ce5ac1e37e89 Mon Sep 17 00:00:00 2001 From: Sergey Kuznetsov Date: Tue, 12 Dec 2023 17:07:51 +0000 Subject: [PATCH] Add status to readme (#1035) For #844 --- .github/workflows/build.yml | 2 +- .github/workflows/nightly.yml | 2 +- README.md | 17 ++++++++++++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 42591734..ca2db785 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,4 +1,4 @@ -name: Build Clio +name: Build on: push: branches: [master, release/*, develop] diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index b6b250f4..1c1610f9 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -1,4 +1,4 @@ -name: Nightly Clio build and testing +name: Nightly release on: schedule: - cron: '0 5 * * 1-5' diff --git a/README.md b/README.md index ff2b2266..48e9516c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # Clio +![Build status](https://github.com/XRPLF/clio/actions/workflows/build.yml/badge.svg?branch=develop) +![Nightly release status](https://github.com/XRPLF/clio/actions/workflows/nightly.yml/badge.svg?branch=develop) +![Clang-tidy checks status](https://github.com/XRPLF/clio/actions/workflows/clang-tidy.yml/badge.svg?branch=develop) Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over WebSocket or JSON-RPC. Validated historical ledger and transaction data are stored in a more space-efficient format, @@ -91,7 +94,7 @@ conan remove -f xrpl Navigate to Clio's root directory and perform ```sh mkdir build && cd build -conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True +conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release .. cmake --build . --parallel 8 # or without the number if you feel extra adventurous ``` @@ -101,6 +104,18 @@ If all goes well, `conan install` will find required packages and `cmake` will d > **Tip:** To generate a Code Coverage report, include `-o coverage=True` in the `conan install` command above, along with `-o tests=True` to enable tests. After running the `cmake` commands, execute `make clio_tests-ccov`. The coverage report will be found at `clio_tests-llvm-cov/index.html`. +## Building Clio with Docker + +It is possible to build Clio using docker if you don't want to install all the dependencies on your machine. +```sh +docker run -it rippleci/clio_ci:latest +git clone https://github.com/XRPLF/clio +mkdir build && cd build +conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False +cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release .. +cmake --build . --parallel 8 # or without the number if you feel extra adventurous +``` + ## Running ```sh ./clio_server config.json