.github/workflows/main.yml

   1 name: CI
   2
   3 on: [push, pull_request]
   4
   5 env:
   6   DEVELOPER: 1
   7
   8 # If more than one workflow run is triggered for the very same commit hash
   9 # (which happens when multiple branches pointing to the same commit), only
  10 # the first one is allowed to run, the second will be kept in the "queued"
  11 # state. This allows a successful completion of the first run to be reused
  12 # in the second run via the `skip-if-redundant` logic in the `config` job.
  13 #
  14 # The only caveat is that if a workflow run is triggered for the same commit
  15 # hash that another run is already being held, that latter run will be
  16 # canceled. For more details about the `concurrency` attribute, see:
  17 # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
  18 concurrency:
  19   group: ${{ github.sha }}
  20
  21 jobs:
  22   ci-config:
  23     name: config
  24     if: vars.CI_BRANCHES == '' || contains(vars.CI_BRANCHES, github.ref_name)
  25     runs-on: ubuntu-latest
  26     outputs:
  27       enabled: ${{ steps.check-ref.outputs.enabled }}${{ steps.skip-if-redundant.outputs.enabled }}
  28       skip_concurrent: ${{ steps.check-ref.outputs.skip_concurrent }}
  29     steps:
  30       - name: try to clone ci-config branch
  31         run: |
  32           git -c protocol.version=2 clone \
  33             --no-tags \
  34             --single-branch \
  35             -b ci-config \
  36             --depth 1 \
  37             --no-checkout \
  38             --filter=blob:none \
  39             https://github.com/${{ github.repository }} \
  40             config-repo &&
  41           cd config-repo &&
  42           git checkout HEAD -- ci/config || : ignore
  43       - id: check-ref
  44         name: check whether CI is enabled for ref
  45         run: |
  46           enabled=yes
  47           if test -x config-repo/ci/config/allow-ref
  48           then
  49             echo "::warning::ci/config/allow-ref is deprecated; use CI_BRANCHES instead"
  50             if ! config-repo/ci/config/allow-ref '${{ github.ref }}'
  51             then
  52               enabled=no
  53             fi
  54           fi
  55
  56           skip_concurrent=yes
  57           if test -x config-repo/ci/config/skip-concurrent &&
  58              ! config-repo/ci/config/skip-concurrent '${{ github.ref }}'
  59           then
  60             skip_concurrent=no
  61           fi
  62           echo "enabled=$enabled" >>$GITHUB_OUTPUT
  63           echo "skip_concurrent=$skip_concurrent" >>$GITHUB_OUTPUT
  64       - name: skip if the commit or tree was already tested
  65         id: skip-if-redundant
  66         uses: actions/github-script@v7
  67         if: steps.check-ref.outputs.enabled == 'yes'
  68         with:
  69           github-token: ${{secrets.GITHUB_TOKEN}}
  70           script: |
  71             try {
  72               // Figure out workflow ID, commit and tree
  73               const { data: run } = await github.rest.actions.getWorkflowRun({
  74                 owner: context.repo.owner,
  75                 repo: context.repo.repo,
  76                 run_id: context.runId,
  77               });
  78               const workflow_id = run.workflow_id;
  79               const head_sha = run.head_sha;
  80               const tree_id = run.head_commit.tree_id;
  81
  82               // See whether there is a successful run for that commit or tree
  83               const { data: runs } = await github.rest.actions.listWorkflowRuns({
  84                 owner: context.repo.owner,
  85                 repo: context.repo.repo,
  86                 per_page: 500,
  87                 status: 'success',
  88                 workflow_id,
  89               });
  90               for (const run of runs.workflow_runs) {
  91                 if (head_sha === run.head_sha) {
  92                   core.warning(`Successful run for the commit ${head_sha}: ${run.html_url}`);
  93                   core.setOutput('enabled', ' but skip');
  94                   break;
  95                 }
  96                 if (run.head_commit && tree_id === run.head_commit.tree_id) {
  97                   core.warning(`Successful run for the tree ${tree_id}: ${run.html_url}`);
  98                   core.setOutput('enabled', ' but skip');
  99                   break;
 100                 }
 101               }
 102             } catch (e) {
 103               core.warning(e);
 104             }
 105
 106   windows-build:
 107     name: win build
 108     needs: ci-config
 109     if: needs.ci-config.outputs.enabled == 'yes'
 110     runs-on: windows-latest
 111     concurrency:
 112       group: windows-build-${{ github.ref }}
 113       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 114     steps:
 115     - uses: actions/checkout@v4
 116     - uses: git-for-windows/setup-git-for-windows-sdk@v1
 117     - name: build
 118       shell: bash
 119       env:
 120         HOME: ${{runner.workspace}}
 121         NO_PERL: 1
 122       run: . /etc/profile && ci/make-test-artifacts.sh artifacts
 123     - name: zip up tracked files
 124       run: git archive -o artifacts/tracked.tar.gz HEAD
 125     - name: upload tracked files and build artifacts
 126       uses: actions/upload-artifact@v4
 127       with:
 128         name: windows-artifacts
 129         path: artifacts
 130   windows-test:
 131     name: win test
 132     runs-on: windows-latest
 133     needs: [ci-config, windows-build]
 134     strategy:
 135       fail-fast: false
 136       matrix:
 137         nr: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 138     concurrency:
 139       group: windows-test-${{ matrix.nr }}-${{ github.ref }}
 140       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 141     steps:
 142     - name: download tracked files and build artifacts
 143       uses: actions/download-artifact@v4
 144       with:
 145         name: windows-artifacts
 146         path: ${{github.workspace}}
 147     - name: extract tracked files and build artifacts
 148       shell: bash
 149       run: tar xf artifacts.tar.gz && tar xf tracked.tar.gz
 150     - uses: git-for-windows/setup-git-for-windows-sdk@v1
 151     - name: test
 152       shell: bash
 153       run: . /etc/profile && ci/run-test-slice.sh ${{matrix.nr}} 10
 154     - name: print test failures
 155       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 156       shell: bash
 157       run: ci/print-test-failures.sh
 158     - name: Upload failed tests' directories
 159       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 160       uses: actions/upload-artifact@v4
 161       with:
 162         name: failed-tests-windows-${{ matrix.nr }}
 163         path: ${{env.FAILED_TEST_ARTIFACTS}}
 164   vs-build:
 165     name: win+VS build
 166     needs: ci-config
 167     if: github.event.repository.owner.login == 'git-for-windows' && needs.ci-config.outputs.enabled == 'yes'
 168     env:
 169       NO_PERL: 1
 170       GIT_CONFIG_PARAMETERS: "'user.name=CI' 'user.email=ci@git'"
 171     runs-on: windows-latest
 172     concurrency:
 173       group: vs-build-${{ github.ref }}
 174       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 175     steps:
 176     - uses: actions/checkout@v4
 177     - uses: git-for-windows/setup-git-for-windows-sdk@v1
 178     - name: initialize vcpkg
 179       uses: actions/checkout@v4
 180       with:
 181         repository: 'microsoft/vcpkg'
 182         path: 'compat/vcbuild/vcpkg'
 183     - name: download vcpkg artifacts
 184       shell: powershell
 185       run: |
 186         $urlbase = "https://dev.azure.com/git/git/_apis/build/builds"
 187         $id = ((Invoke-WebRequest -UseBasicParsing "${urlbase}?definitions=9&statusFilter=completed&resultFilter=succeeded&`$top=1").content | ConvertFrom-JSON).value[0].id
 188         $downloadUrl = ((Invoke-WebRequest -UseBasicParsing "${urlbase}/$id/artifacts").content | ConvertFrom-JSON).value[0].resource.downloadUrl
 189         (New-Object Net.WebClient).DownloadFile($downloadUrl, "compat.zip")
 190         Expand-Archive compat.zip -DestinationPath . -Force
 191         Remove-Item compat.zip
 192     - name: add msbuild to PATH
 193       uses: microsoft/setup-msbuild@v1
 194     - name: copy dlls to root
 195       shell: cmd
 196       run: compat\vcbuild\vcpkg_copy_dlls.bat release
 197     - name: generate Visual Studio solution
 198       shell: bash
 199       run: |
 200         cmake `pwd`/contrib/buildsystems/ -DCMAKE_PREFIX_PATH=`pwd`/compat/vcbuild/vcpkg/installed/x64-windows \
 201         -DNO_GETTEXT=YesPlease -DPERL_TESTS=OFF -DPYTHON_TESTS=OFF -DCURL_NO_CURL_CMAKE=ON
 202     - name: MSBuild
 203       run: msbuild git.sln -property:Configuration=Release -property:Platform=x64 -maxCpuCount:4 -property:PlatformToolset=v142
 204     - name: bundle artifact tar
 205       shell: bash
 206       env:
 207         MSVC: 1
 208         VCPKG_ROOT: ${{github.workspace}}\compat\vcbuild\vcpkg
 209       run: |
 210         mkdir -p artifacts &&
 211         eval "$(make -n artifacts-tar INCLUDE_DLLS_IN_ARTIFACTS=YesPlease ARTIFACTS_DIRECTORY=artifacts NO_GETTEXT=YesPlease 2>&1 | grep ^tar)"
 212     - name: zip up tracked files
 213       run: git archive -o artifacts/tracked.tar.gz HEAD
 214     - name: upload tracked files and build artifacts
 215       uses: actions/upload-artifact@v4
 216       with:
 217         name: vs-artifacts
 218         path: artifacts
 219   vs-test:
 220     name: win+VS test
 221     runs-on: windows-latest
 222     needs: [ci-config, vs-build]
 223     strategy:
 224       fail-fast: false
 225       matrix:
 226         nr: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 227     concurrency:
 228       group: vs-test-${{ matrix.nr }}-${{ github.ref }}
 229       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 230     steps:
 231     - uses: git-for-windows/setup-git-for-windows-sdk@v1
 232     - name: download tracked files and build artifacts
 233       uses: actions/download-artifact@v4
 234       with:
 235         name: vs-artifacts
 236         path: ${{github.workspace}}
 237     - name: extract tracked files and build artifacts
 238       shell: bash
 239       run: tar xf artifacts.tar.gz && tar xf tracked.tar.gz
 240     - name: test
 241       shell: bash
 242       env:
 243         NO_SVN_TESTS: 1
 244       run: . /etc/profile && ci/run-test-slice.sh ${{matrix.nr}} 10
 245     - name: print test failures
 246       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 247       shell: bash
 248       run: ci/print-test-failures.sh
 249     - name: Upload failed tests' directories
 250       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 251       uses: actions/upload-artifact@v4
 252       with:
 253         name: failed-tests-windows-vs-${{ matrix.nr }}
 254         path: ${{env.FAILED_TEST_ARTIFACTS}}
 255   regular:
 256     name: ${{matrix.vector.jobname}} (${{matrix.vector.pool}})
 257     needs: ci-config
 258     if: needs.ci-config.outputs.enabled == 'yes'
 259     concurrency:
 260       group: ${{ matrix.vector.jobname }}-${{ matrix.vector.pool }}-${{ github.ref }}
 261       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 262     strategy:
 263       fail-fast: false
 264       matrix:
 265         vector:
 266           - jobname: linux-sha256
 267             cc: clang
 268             pool: ubuntu-latest
 269           - jobname: linux-reftable
 270             cc: clang
 271             pool: ubuntu-latest
 272           - jobname: linux-gcc
 273             cc: gcc
 274             cc_package: gcc-8
 275             pool: ubuntu-20.04
 276           - jobname: linux-TEST-vars
 277             cc: gcc
 278             cc_package: gcc-8
 279             pool: ubuntu-20.04
 280           - jobname: osx-clang
 281             cc: clang
 282             pool: macos-13
 283           - jobname: osx-reftable
 284             cc: clang
 285             pool: macos-13
 286           - jobname: osx-gcc
 287             cc: gcc-13
 288             pool: macos-13
 289           - jobname: linux-gcc-default
 290             cc: gcc
 291             pool: ubuntu-latest
 292           - jobname: linux-leaks
 293             cc: gcc
 294             pool: ubuntu-latest
 295           - jobname: linux-reftable-leaks
 296             cc: gcc
 297             pool: ubuntu-latest
 298           - jobname: linux-asan-ubsan
 299             cc: clang
 300             pool: ubuntu-latest
 301     env:
 302       CC: ${{matrix.vector.cc}}
 303       CC_PACKAGE: ${{matrix.vector.cc_package}}
 304       jobname: ${{matrix.vector.jobname}}
 305       distro: ${{matrix.vector.pool}}
 306     runs-on: ${{matrix.vector.pool}}
 307     steps:
 308     - uses: actions/checkout@v4
 309     - run: ci/install-dependencies.sh
 310     - run: ci/run-build-and-tests.sh
 311     - name: print test failures
 312       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 313       run: ci/print-test-failures.sh
 314     - name: Upload failed tests' directories
 315       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 316       uses: actions/upload-artifact@v4
 317       with:
 318         name: failed-tests-${{matrix.vector.jobname}}
 319         path: ${{env.FAILED_TEST_ARTIFACTS}}
 320   fuzz-smoke-test:
 321     name: fuzz smoke test
 322     needs: ci-config
 323     if: needs.ci-config.outputs.enabled == 'yes'
 324     env:
 325       CC: clang
 326     runs-on: ubuntu-latest
 327     steps:
 328     - uses: actions/checkout@v4
 329     - run: ci/install-dependencies.sh
 330     - run: ci/run-build-and-minimal-fuzzers.sh
 331   dockerized:
 332     name: ${{matrix.vector.jobname}} (${{matrix.vector.image}})
 333     needs: ci-config
 334     if: needs.ci-config.outputs.enabled == 'yes'
 335     concurrency:
 336       group: dockerized-${{ matrix.vector.jobname }}-${{ matrix.vector.image }}-${{ github.ref }}
 337       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 338     strategy:
 339       fail-fast: false
 340       matrix:
 341         vector:
 342         - jobname: linux-musl
 343           image: alpine
 344           distro: alpine-latest
 345         - jobname: linux32
 346           image: daald/ubuntu32:xenial
 347           distro: ubuntu32-16.04
 348         - jobname: pedantic
 349           image: fedora
 350           distro: fedora-latest
 351     env:
 352       jobname: ${{matrix.vector.jobname}}
 353       distro: ${{matrix.vector.distro}}
 354     runs-on: ubuntu-latest
 355     container: ${{matrix.vector.image}}
 356     steps:
 357     - uses: actions/checkout@v4
 358       if: matrix.vector.jobname != 'linux32'
 359     - uses: actions/checkout@v1 # cannot be upgraded because Node.js Actions aren't supported in this container
 360       if: matrix.vector.jobname == 'linux32'
 361     - run: ci/install-dependencies.sh
 362     - run: ci/run-build-and-tests.sh
 363     - name: print test failures
 364       if: failure() && env.FAILED_TEST_ARTIFACTS != ''
 365       run: ci/print-test-failures.sh
 366     - name: Upload failed tests' directories
 367       if: failure() && env.FAILED_TEST_ARTIFACTS != '' && matrix.vector.jobname != 'linux32'
 368       uses: actions/upload-artifact@v4
 369       with:
 370         name: failed-tests-${{matrix.vector.jobname}}
 371         path: ${{env.FAILED_TEST_ARTIFACTS}}
 372     - name: Upload failed tests' directories
 373       if: failure() && env.FAILED_TEST_ARTIFACTS != '' && matrix.vector.jobname == 'linux32'
 374       uses: actions/upload-artifact@v1 # cannot be upgraded because Node.js Actions aren't supported in this container
 375       with:
 376         name: failed-tests-${{matrix.vector.jobname}}
 377         path: ${{env.FAILED_TEST_ARTIFACTS}}
 378   static-analysis:
 379     needs: ci-config
 380     if: needs.ci-config.outputs.enabled == 'yes'
 381     env:
 382       jobname: StaticAnalysis
 383     runs-on: ubuntu-22.04
 384     concurrency:
 385       group: static-analysis-${{ github.ref }}
 386       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 387     steps:
 388     - uses: actions/checkout@v4
 389     - run: ci/install-dependencies.sh
 390     - run: ci/run-static-analysis.sh
 391     - run: ci/check-directional-formatting.bash
 392   sparse:
 393     needs: ci-config
 394     if: needs.ci-config.outputs.enabled == 'yes'
 395     env:
 396       jobname: sparse
 397     runs-on: ubuntu-20.04
 398     concurrency:
 399       group: sparse-${{ github.ref }}
 400       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 401     steps:
 402     - name: Download a current `sparse` package
 403       # Ubuntu's `sparse` version is too old for us
 404       uses: git-for-windows/get-azure-pipelines-artifact@v0
 405       with:
 406         repository: git/git
 407         definitionId: 10
 408         artifact: sparse-20.04
 409     - name: Install the current `sparse` package
 410       run: sudo dpkg -i sparse-20.04/sparse_*.deb
 411     - uses: actions/checkout@v4
 412     - name: Install other dependencies
 413       run: ci/install-dependencies.sh
 414     - run: make sparse
 415   documentation:
 416     name: documentation
 417     needs: ci-config
 418     if: needs.ci-config.outputs.enabled == 'yes'
 419     concurrency:
 420       group: documentation-${{ github.ref }}
 421       cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }}
 422     env:
 423       jobname: Documentation
 424     runs-on: ubuntu-latest
 425     steps:
 426     - uses: actions/checkout@v4
 427     - run: ci/install-dependencies.sh
 428     - run: ci/test-documentation.sh