Flow should not need capnp (ipc* does); ~Same changes made to flow/same-stuff also applied here (details omitted); highlight: manual workflow runnability; highlight: create tarball with docs and landing page which also hugely speeds up the artifact generation. Minor tweak for consistency in make arg order. Added TODO regarding how our CMake script should be able to determine jemalloc-prefix by itself, though giving it manually is certainly supported too. Renamed pipeline a bit (it is Flow-IPC; might as well keep "branding" consistent.
#17
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Flow-IPC pipeline | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| doc: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| compiler: | |
| - { id: clang-15, name: clang, version: 15, c-path: /usr/bin/clang-15, cpp-path: /usr/bin/clang++-15 } | |
| build-type: | |
| - { id: release, conan-name: Release, conan-preset: release } | |
| runs-on: ubuntu-latest | |
| name: | | |
| doc-${{ matrix.compiler.id }}-${{ matrix.build-type.id }} | |
| steps: | |
| - name: Update available software list for apt-get | |
| run: sudo apt-get update | |
| - name: Checkout `ipc` repository and submodules (`flow`, `ipc_*`) | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install Flow-IPC dependencies (inc. Graphviz) with apt-get | |
| run: | | |
| sudo apt-get install -y graphviz | |
| - name: Install Conan 1.x | |
| run: | | |
| pip install "conan<2" | |
| - name: Create Conan profile | |
| run: | | |
| cat <<EOF > conan_profile | |
| [settings] | |
| compiler = ${{ matrix.compiler.name }} | |
| compiler.version = ${{ matrix.compiler.version }} | |
| compiler.cppstd = 17 | |
| compiler.libcxx = libstdc++11 | |
| arch = x86_64 | |
| os = Linux | |
| build_type = ${{ matrix.build-type.conan-name }} | |
| [conf] | |
| tools.build:compiler_executables = {"c": "${{ matrix.compiler.c-path }}", "cpp": "${{ matrix.compiler.cpp-path }}"} | |
| tools.env.virtualenv:auto_use = True | |
| [buildenv] | |
| CC = ${{ matrix.compiler.c-path }} | |
| CXX = ${{ matrix.compiler.cpp-path }} | |
| [options] | |
| ipc:build = False | |
| ipc:doc = True | |
| EOF | |
| - name: Install Flow-IPC dependencies (inc. Doxygen) with Conan using the profile | |
| run: | | |
| conan install \ | |
| . \ | |
| --profile:build=conan_profile \ | |
| --profile:host=conan_profile \ | |
| --build=missing | |
| - name: Prepare Makefile using CMake | |
| run: | | |
| cmake \ | |
| --preset ${{ matrix.build-type.conan-preset }} \ | |
| -DCFG_ENABLE_DOC_GEN=ON \ | |
| -DCFG_SKIP_CODE_GEN=ON | |
| - name: Get the number of processor cores for parallelized work | |
| uses: SimenB/github-actions-cpu-cores@v1 | |
| id: cpu-cores | |
| # Note that `flow_doc_public` and `flow_doc_full` targets are also available; and a user locally | |
| # may well want to use them. We, however, have chosen to dedicate a Flow-only workflow | |
| # (in `flow` repo) to Flow; it will generate the Flow docs. Meanwhile ipc_doc_* targets create | |
| # monolithic documentation from the ipc_* submodules and `ipc` itself -- but *not* from | |
| # `flow` submodule. | |
| - name: Doxygen-generate documentation sets using Makefile | |
| run: | | |
| VERBOSE=1 make \ | |
| ipc_doc_public \ | |
| ipc_doc_full \ | |
| --directory $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }} \ | |
| -j${{ steps.cpu-cores.outputs.count }} | |
| - name: Package doc tarball [Doxygen documentation sets (full, API-only), landing page] | |
| run: | | |
| cd $GITHUB_WORKSPACE/doc/ipc_doc | |
| $GITHUB_WORKSPACE/tools/doc/stage_generated_docs.sh $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }} | |
| - name: Upload documentation tarball | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: ipc-doc-${{ matrix.compiler.id }}-${{ matrix.build-type.id }} | |
| path: | | |
| ${{ github.workspace }}/doc/ipc_doc.tgz | |
| build: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| compiler: | |
| - { id: gcc-9, name: gcc, version: 9, c-path: /usr/bin/gcc-9, cpp-path: /usr/bin/g++-9 } | |
| - { id: gcc-10, name: gcc, version: 10, c-path: /usr/bin/gcc-10, cpp-path: /usr/bin/g++-10 } | |
| - { id: gcc-11, name: gcc, version: 11, c-path: /usr/bin/gcc-11, cpp-path: /usr/bin/g++-11 } | |
| - { id: gcc-13, name: gcc, version: 13, c-path: /usr/bin/gcc-13, cpp-path: /usr/bin/g++-13 } | |
| - { id: clang-13, name: clang, version: 13, c-path: /usr/bin/clang-13, cpp-path: /usr/bin/clang++-13 } | |
| - { id: clang-15, name: clang, version: 15, c-path: /usr/bin/clang-15, cpp-path: /usr/bin/clang++-15 } | |
| - { id: clang-16, name: clang, version: 16, c-path: /usr/bin/clang-16, cpp-path: /usr/bin/clang++-16, install: True } | |
| - { id: clang-17, name: clang, version: 17, c-path: /usr/bin/clang-17, cpp-path: /usr/bin/clang++-17, install: True } | |
| build-type: | |
| - { id: debug, conan-name: Debug, conan-jemalloc: Debug, conan-preset: debug } | |
| - { id: release, conan-name: Release, conan-jemalloc: Release, conan-preset: release } | |
| - { id: relwithdebinfo, conan-name: RelWithDebInfo, conan-jemalloc: Release, conan-preset: relwithdebinfo } | |
| - { id: minsizerel, conan-name: MinSizeRel, conan-jemalloc: Release, conan-preset: minsizerel} | |
| runs-on: ubuntu-latest | |
| name: | | |
| build-${{ matrix.compiler.id }}-${{ matrix.build-type.id }} | |
| steps: | |
| - name: Update available software list for apt-get | |
| run: sudo apt-get update | |
| - name: Checkout `ipc` repository and submodules (`flow`, `ipc_*`) | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install clang compiler | |
| run: | | |
| wget https://apt.llvm.org/llvm.sh | |
| chmod u+x llvm.sh | |
| sudo ./llvm.sh ${{ matrix.compiler.version }} | |
| if: | | |
| matrix.compiler.install && matrix.compiler.name == 'clang' | |
| - name: Install gcc compiler | |
| run: | | |
| sudo apt-get install -y software-properties-common | |
| sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y | |
| sudo apt-get update | |
| sudo apt-get install -y gcc-${{ matrix.compiler.version }} g++-${{ matrix.compiler.version }} | |
| if: | | |
| matrix.compiler.install && matrix.compiler.name == 'gcc' | |
| - name: Install Conan 1.x | |
| run: | | |
| pip install "conan<2" | |
| - name: Create Conan profile | |
| run: | | |
| cat <<EOF > conan_profile | |
| [settings] | |
| compiler = ${{ matrix.compiler.name }} | |
| compiler.version = ${{ matrix.compiler.version }} | |
| compiler.cppstd = 17 | |
| compiler.libcxx = libstdc++11 | |
| arch = x86_64 | |
| os = Linux | |
| build_type = ${{ matrix.build-type.conan-name }} | |
| jemalloc:build_type = ${{ matrix.build-type.conan-jemalloc }} | |
| [conf] | |
| tools.build:compiler_executables = {"c": "${{ matrix.compiler.c-path }}", "cpp": "${{ matrix.compiler.cpp-path }}"} | |
| tools.env.virtualenv:auto_use = True | |
| [buildenv] | |
| CC = ${{ matrix.compiler.c-path }} | |
| CXX = ${{ matrix.compiler.cpp-path }} | |
| [options] | |
| jemalloc:enable_cxx = False | |
| jemalloc:prefix = je_ | |
| ipc:build = True | |
| ipc:doc = False | |
| flow:build = True | |
| flow:doc = False | |
| EOF | |
| - name: Install Flow-IPC dependencies with Conan using the profile | |
| run: | | |
| conan editable add flow flow/1.0 | |
| conan install \ | |
| . \ | |
| --profile:build=conan_profile \ | |
| --profile:host=conan_profile \ | |
| --build=missing | |
| - name: Get the number of processor cores for parallelized work | |
| uses: SimenB/github-actions-cpu-cores@v1 | |
| id: cpu-cores | |
| # TODO: Ideally let our CMake interrogate jemalloc-config to find jemalloc-prefix itself. | |
| # Less stuff for us to worry about that way here. If it has not been tried, try it. | |
| # If it does not work, apply a small effort to see if it can be easily made to work. | |
| # | |
| # TODO: It seems unusual to place install-prefix inside build-prefix. | |
| - name: Prepare Makefile using CMake | |
| run: | | |
| cmake \ | |
| --preset ${{ matrix.build-type.conan-preset }} \ | |
| -DCFG_ENABLE_TEST_SUITE=ON \ | |
| -DJEMALLOC_PREFIX=je_ \ | |
| -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install | |
| - name: Build targets (libraries, demos/tests) with Makefile | |
| run: | | |
| VERBOSE=1 make \ | |
| --keep-going \ | |
| --directory $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }} \ | |
| -j${{ steps.cpu-cores.outputs.count }} | |
| - name: Install targets with Makefile | |
| run: | | |
| VERBOSE=1 make install \ | |
| --directory $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }} \ | |
| -j${{ steps.cpu-cores.outputs.count }} | |
| - name: Run link test [`ipc_core` - Flow-IPC Core] | |
| run: | | |
| cd $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install/bin | |
| ./ipc_core_link_test.exec | |
| - name: Run link test [`ipc_transport_structured` - Flow-IPC Structured Transport] | |
| run: | | |
| cd $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install/bin | |
| ./ipc_transport_structured_link_test.exec | |
| # Server will exit automatically (same below). | |
| - name: Run link test [`ipc_session` - Flow-IPC Sessions] | |
| run: | | |
| cd $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install/bin | |
| ./ipc_session_link_test_srv.exec & | |
| sleep 1 | |
| ./ipc_session_link_test_cli.exec | |
| - name: Run link test [`ipc_shm` - Flow-IPC Shared Memory] | |
| run: | | |
| cd $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install/bin | |
| ./ipc_shm_link_test_srv.exec & | |
| sleep 1 | |
| ./ipc_shm_link_test_cli.exec | |
| - name: Run link test [`ipc_shm_arena_lend` - Flow-IPC SHM-jemalloc] | |
| run: | | |
| cd $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install/bin | |
| ./ipc_shm_arena_lend_link_test_srv.exec & | |
| sleep 1 | |
| ./ipc_shm_arena_lend_link_test_cli.exec | |
| - name: Run unit tests | |
| run: | | |
| cd $GITHUB_WORKSPACE/build/${{ matrix.build-type.conan-name }}/install/bin | |
| ./libipc_unit_test.exec |