Antora Work #2261
Workflow file for this run
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
| # | ||
| # Copyright (c) 2023 Alan de Freitas | ||
| # Copyright (c) 2021-2023 Sam Darwin | ||
| # Copyright (c) 2020-2021 Peter Dimov | ||
| # Copyright (c) 2021 Andrey Semashev | ||
| # | ||
| # Distributed under the Boost Software License, Version 1.0. (See accompanying | ||
| # file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | ||
| # | ||
| # Official repository: https://github.com/boostorg/url | ||
| # | ||
| name: CI | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - master | ||
| - develop | ||
| - feature/** | ||
| push: | ||
| branches: | ||
| - '*' | ||
| tags: | ||
| - "boost-*.*.*" | ||
| concurrency: | ||
| group: ${{format('{0}:{1}', github.repository, github.ref)}} | ||
| cancel-in-progress: true | ||
| env: | ||
| GIT_FETCH_JOBS: 8 | ||
| NET_RETRY_COUNT: 5 | ||
| DEFAULT_BUILD_VARIANT: debug,release | ||
| jobs: | ||
| runner-selection: | ||
| name: Runner Selection | ||
| runs-on: ${{ github.repository_owner == 'boostorg' && fromJSON('[ "self-hosted", "linux", "x64", "ubuntu-latest-aws" ]') || 'ubuntu-latest' }} | ||
| outputs: | ||
| labelmatrix: ${{ steps.aws_hosted_runners.outputs.labelmatrix }} | ||
| steps: | ||
| - name: AWS Hosted Runners | ||
| id: aws_hosted_runners | ||
| uses: cppalliance/[email protected] | ||
| cpp-matrix: | ||
| needs: [ runner-selection ] | ||
| runs-on: ${{ fromJSON(needs.runner-selection.outputs.labelmatrix)['ubuntu-latest'] }} | ||
| name: Generate Test Matrix | ||
| outputs: | ||
| matrix: [{ "name": "Clang 16: C++20 (Time-Trace)","compiler": "clang","version": "16","env": { },"cxxstd": "20","latest-cxxstd": "20","major": 16,"minor": 0,"patch": "*","runs-on": "ubuntu-22.04","container": "ubuntu:23.04","b2-toolset": "clang","is-latest": false,"is-main": false,"is-earliest": false,"is-intermediary": true,"has-major": true,"has-minor": true,"has-patch": false,"subrange-policy": "one-per-minor","time-trace": true,"has-factors": true,"fuzz": false,"is-no-factor-intermediary": false,"shared": false,"x86": false,"build-type": "Release","cxxflags": "-ftime-trace","ccflags": "-ftime-trace","install": "wget unzip build-essential","triplet": "x64-linux" }] | ||
| steps: | ||
| - name: Generate Test Matrix | ||
| uses: alandefreitas/cpp-actions/cpp-matrix@develop | ||
| id: cpp-matrix | ||
| with: | ||
| compilers: | | ||
| gcc >=4.8 | ||
| clang >=3.8 | ||
| msvc >=14.20 | ||
| apple-clang * | ||
| mingw * | ||
| clang-cl * | ||
| standards: '>=11' | ||
| latest-factors: | | ||
| gcc Coverage UBSan | ||
| factors: | | ||
| gcc Asan Shared No-Threads | ||
| msvc Shared x86 | ||
| clang Time-Trace Fuzz | ||
| mingw Shared | ||
| trace-commands: true | ||
| build: | ||
| needs: [ cpp-matrix,runner-selection ] | ||
| defaults: | ||
| run: | ||
| shell: bash | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: ${{ fromJSON(needs.cpp-matrix.outputs.matrix) }} | ||
| name: ${{ matrix.name }} | ||
| runs-on: ${{ fromJSON(needs.runner-selection.outputs.labelmatrix)[matrix.runs-on] }} | ||
| container: ${{ matrix.container }} | ||
| env: ${{ matrix.env }} | ||
| timeout-minutes: 120 | ||
| steps: | ||
| - name: Clone Boost.URL | ||
| uses: actions/checkout@v3 | ||
| - name: Setup C++ | ||
| uses: alandefreitas/cpp-actions/setup-cpp@develop | ||
| id: setup-cpp | ||
| with: | ||
| compiler: ${{ matrix.compiler }} | ||
| version: ${{ (matrix.subrange-policy == 'one-per-major' && matrix.major) || matrix.version }} | ||
| - name: Install packages | ||
| if: matrix.install != '' | ||
| uses: alandefreitas/cpp-actions/package-install@develop | ||
| id: package-install | ||
| with: | ||
| apt-get: ${{ matrix.install }} | ||
| - name: Clone Boost | ||
| uses: alandefreitas/cpp-actions/boost-clone@develop | ||
| id: boost-clone | ||
| with: | ||
| branch: ${{ (github.ref_name == 'master' && github.ref_name) || 'develop' }} | ||
| boost-dir: ../boost-source | ||
| scan-modules-dir: . | ||
| scan-modules-ignore: url | ||
| - name: Setup | ||
| id: patch | ||
| shell: bash | ||
| run: | | ||
| set -xe | ||
| # GitHub workspace root | ||
| workspace_root=$(echo "$GITHUB_WORKSPACE" | sed 's/\\/\//g') | ||
| echo -E "workspace_root=$workspace_root" >> $GITHUB_OUTPUT | ||
| # Boost module being tested | ||
| module=${GITHUB_REPOSITORY#*/} | ||
| echo "module=$module" >> $GITHUB_OUTPUT | ||
| # Remove module from Boost source files | ||
| rm -r "../boost-source/libs/$module" || true | ||
| # Copy cached Boost source files to an isolated directory | ||
| mkdir "../boost-root" || true | ||
| cp -r "../boost-source"/* "../boost-root" | ||
| # Boost root directory | ||
| cd "../boost-root" | ||
| boost_root="$(pwd)" | ||
| boost_root=$(echo "$boost_root" | sed 's/\\/\//g') | ||
| echo -E "boost_root=$boost_root" >> $GITHUB_OUTPUT | ||
| # Patch boost-root with workspace module | ||
| mkdir "libs/$module" | ||
| cp -r "$workspace_root"/* "libs/$module" | ||
| # Default parameters for CMake workflows | ||
| echo 'CMAKE_GENERATOR=${{ matrix.generator || '' }}' >> $GITHUB_ENV | ||
| echo 'CMAKE_GENERATOR_TOOLSET=${{ matrix.generator-toolset || '' }}' >> $GITHUB_ENV | ||
| echo 'CMAKE_BUILD_TYPE=${{ matrix.build-type || '' }}' >> $GITHUB_ENV | ||
| echo 'CC=${{ steps.setup-cpp.outputs.cc || matrix.cc || '' }}' >> $GITHUB_ENV | ||
| echo 'CFLAGS=${{ matrix.ccflags || '' }}' >> $GITHUB_ENV | ||
| echo 'CXX=${{ steps.setup-cpp.outputs.cxx || matrix.cxx || '' }}' >> $GITHUB_ENV | ||
| echo 'CXXFLAGS=${{ matrix.cxxflags || '' }}' >> $GITHUB_ENV | ||
| echo 'CXXSTD=${{ matrix.latest-cxxstd || '' }}' >> $GITHUB_ENV | ||
| echo 'BUILD_SHARED_LIBS=${{ matrix.shared || '' }}' >> $GITHUB_ENV | ||
| echo 'CMAKE_RUN_TESTS=true' >> $GITHUB_ENV | ||
| echo 'CMAKE_PACKAGE=false' >> $GITHUB_ENV | ||
| # Set PATH to find Boost DLLs | ||
| if [ ${{ matrix.shared }} == "true" ]; then | ||
| echo "$GITHUB_WORKSPACE/.local/bin" >> $GITHUB_PATH | ||
| fi | ||
| - name: Fuzz corpus | ||
| if: matrix.fuzz | ||
| uses: actions/[email protected] | ||
| id: cache-corpus | ||
| with: | ||
| path: ${{ steps.patch.outputs.workspace_root }}/corpus.tar | ||
| key: corpus-${{ github.run_id }} | ||
| enableCrossOsArchive: true | ||
| restore-keys: | | ||
| corpus- | ||
| - name: CMake Workflow | ||
| uses: alandefreitas/cpp-actions/cmake-workflow@develop | ||
| if: matrix.is-no-factor-intermediary != 'true' | ||
| with: | ||
| source-dir: ../boost-root | ||
| build-dir: __build_cmake__ | ||
| build-target: tests | ||
| install: true | ||
| install-prefix: .local | ||
| cmake-version: '>=3.15' | ||
| extra-args: | | ||
| -D Boost_VERBOSE=ON | ||
| -D BOOST_INCLUDE_LIBRARIES=${{ steps.patch.outputs.module }} | ||
| -D BOOST_URL_DISABLE_THREADS=${{ ( matrix.no-threads && 'ON' ) || 'OFF' }} | ||
| -D BOOST_URL_BUILD_FUZZERS=${{ ( matrix.fuzz && format('ON -D BOOST_URL_FUZZER_CORPUS_PATH={0}/corpus.tar', steps.patch.outputs.workspace_root) ) || 'OFF' }} | ||
| export-compile-commands: ${{ matrix.time-trace }} | ||
| ref-source-dir: ../boost-root/libs/url | ||
| trace-commands: true | ||
| - name: CMake Integration Workflow | ||
| uses: alandefreitas/cpp-actions/cmake-workflow@develop | ||
| if: matrix.is-no-factor-intermediary != 'true' | ||
| with: | ||
| source-dir: ../boost-root/libs/${{ steps.patch.outputs.module }}/test/cmake_test | ||
| build-dir: __build_cmake_test__ | ||
| install: false | ||
| cmake-version: '>=3.11' | ||
| extra-args: | | ||
| 'find_package(Boost)': -D BOOST_CI_INSTALL_TEST=ON -D CMAKE_PREFIX_PATH=${{ steps.patch.outputs.workspace_root }}/.local | ||
| 'find_package(boost_url)': -D BOOST_CI_INSTALL_MODULE_TEST=ON -D CMAKE_PREFIX_PATH=${{ steps.patch.outputs.workspace_root }}/.local | ||
| 'add_subdirectory(<boost>)': -D BOOST_CI_BOOST_SUBDIR_TEST=ON | ||
| 'add_subdirectory(<url>)': -D BOOST_CI_URL_SUBDIR_TEST=ON | ||
| ref-source-dir: ../boost-root/libs/url | ||
| trace-commands: true | ||
| - name: CMake Root Workflow | ||
| uses: alandefreitas/cpp-actions/cmake-workflow@develop | ||
| if: matrix.is-latest || matrix.is-earliest | ||
| with: | ||
| source-dir: . | ||
| build-dir: __build_cmake_root__ | ||
| build-target: tests | ||
| run-tests: true | ||
| install: false | ||
| cmake-version: '>=3.11' | ||
| extra-args: | | ||
| -D BOOST_SRC_DIR="../boost-root" | ||
| -D BOOST_URL_DISABLE_THREADS=OFF | ||
| ref-source-dir: . | ||
| trace-commands: true | ||
| - name: B2 Workflow | ||
| uses: alandefreitas/cpp-actions/b2-workflow@develop | ||
| env: | ||
| # Set flags via B2 options exclusively | ||
| CFLAGS: '' | ||
| CXXFLAGS: '' | ||
| with: | ||
| source-dir: ../boost-root | ||
| modules: url | ||
| toolset: ${{ matrix.b2-toolset }} | ||
| build-variant: ${{ matrix.build-type }} | ||
| cxx: ${{ steps.setup-cpp.outputs.cxx || matrix.cxx || '' }} | ||
| # If this is the latest compiler version in the matrix, we also append `,latest` to `cxxstd` | ||
| # `latest` is a b2 tag that defaults to the latest C++ standard supported by the compiler, | ||
| # including experimental ones, decaying to placeholders options (such as 0x, 1y, 1z, 2a, 2b, 2c). | ||
| cxxstd: ${{ ( matrix.is-latest && ((matrix.cxxstd && format('{0},latest', matrix.cxxstd)) || 'latest' )) || matrix.cxxstd }} | ||
| address-model: ${{ (matrix.x86 && '32') || '64' }} | ||
| asan: ${{ matrix.asan }} | ||
| ubsan: ${{ matrix.ubsan }} | ||
| tsan: ${{ matrix.tsan }} | ||
| shared: ${{ matrix.shared }} | ||
| - name: FlameGraph | ||
| uses: alandefreitas/cpp-actions/flamegraph@develop | ||
| if: matrix.time-trace | ||
| with: | ||
| source-dir: ../boost-root/libs/url | ||
| build-dir: ../boost-root/__build_cmake__ | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Codecov | ||
| if: matrix.coverage | ||
| run: | | ||
| set -x | ||
| # Generate report | ||
| gcov_tool="gcov" | ||
| if command -v "gcov-${{ steps.setup-cpp.outputs.version-major }}.${{ steps.setup-cpp.outputs.version-minor }}" &> /dev/null; then | ||
| gcov_tool="gcov-${{ steps.setup-cpp.outputs.version-major }}.${{ steps.setup-cpp.outputs.version-minor }}" | ||
| elif command -v "gcov-${{ steps.setup-cpp.outputs.version-major }}" &> /dev/null; then | ||
| gcov_tool="gcov-${{ steps.setup-cpp.outputs.version-major }}" | ||
| fi | ||
| lcov -c -q -o "../boost-root/__build_cmake__/coverage.info" -d "../boost-root/__build_cmake__" --include "$(pwd)/../boost-root/libs/${{steps.patch.outputs.module}}/*" --gcov-tool "$gcov_tool" | ||
| # Upload to codecov | ||
| bash <(curl -s https://codecov.io/bash) -f "../boost-root/__build_cmake__/coverage.info" | ||
| # Summary | ||
| echo "# Coverage" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "[](https://codecov.io/github/$GITHUB_REPOSITORY/commit/$GITHUB_SHA)" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "Commit: [](https://codecov.io/github/$GITHUB_REPOSITORY/commit/$GITHUB_SHA)" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "Branch: [](https://codecov.io/github/$GITHUB_REPOSITORY/commit/$GITHUB_SHA)" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| changelog: | ||
| needs: [ cpp-matrix,runner-selection ] | ||
| defaults: | ||
| run: | ||
| shell: bash | ||
| name: Changelog Summary | ||
| runs-on: ${{ fromJSON(needs.runner-selection.outputs.labelmatrix)['ubuntu-22.04'] }} | ||
| timeout-minutes: 120 | ||
| steps: | ||
| - name: Clone Boost.URL | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| # Avoid the common API rate limit exceeded error in boostorg by including 100 latest commits in any case | ||
| fetch-depth: 100 | ||
| - name: Changelog | ||
| uses: alandefreitas/cpp-actions/create-changelog@develop | ||
| with: | ||
| thank-non-regular: ${{ startsWith(github.ref, 'refs/tags/') }} | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| limit: 200 | ||
| tag-pattern: 'boost-.+\..+\..+' # Match tags like boost-1.75.0 | ||
| trace-commands: true | ||
| antora: | ||
| name: Antora Docs | ||
| needs: [ runner-selection ] | ||
| runs-on: ${{ fromJSON(needs.runner-selection.outputs.labelmatrix)['ubuntu-latest'] }} | ||
| steps: | ||
| - name: Clone Boost.URL | ||
| uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 18 | ||
| - name: Setup C++ | ||
| uses: alandefreitas/cpp-actions/setup-cpp@develop | ||
| id: setup-cpp | ||
| with: | ||
| compiler: clang | ||
| version: 17 | ||
| - name: Build Antora Docs | ||
| run: | | ||
| cd doc | ||
| bash ./build_antora.sh | ||
| - name: Create Antora Docs Artifact | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: antora-docs | ||
| path: doc/build/site | ||
