1# Copyright (c) 2023-present The Bitcoin Core developers
2# Distributed under the MIT software license, see the accompanying
3# file COPYING or https://opensource.org/license/mit.
4
5name: CI
6on:
7  # See: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#pull_request.
8  pull_request:
9  # See: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#push.
10  push:
11    branches:
12      - '**'
13    tags-ignore:
14      - '**'
15
16concurrency:
17  group: ${{ github.event_name != 'pull_request' && github.run_id || github.ref }}
18  cancel-in-progress: true
19
20env:
21  CI_FAILFAST_TEST_LEAVE_DANGLING: 1  # GHA does not care about dangling processes and setting this variable avoids killing the CI script itself on error
22
23defaults:
24  run:
25    # Enforce fail-fast behavior for all platforms.
26    # See: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#exit-codes-and-error-action-preference
27    shell: bash
28
29jobs:
30  test-each-commit:
31    name: 'test ancestor commits'
32    runs-on: ${{ github.repository == 'bitcoin/bitcoin' && 'warp-ubuntu-latest-x64-8x' || 'ubuntu-latest' }}
33    env:
34      TEST_RUNNER_PORT_MIN: "14000"  # Use a larger port range to avoid colliding with other CI services.
35    if: github.event_name == 'pull_request' && github.event.pull_request.commits != 1
36    timeout-minutes: 360  # Use maximum time, see https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes.
37    steps:
38      - name: Determine fetch depth
39        run: echo "FETCH_DEPTH=$((${{ github.event.pull_request.commits }} + 2))" >> "$GITHUB_ENV"
40      - &ANNOTATION_PR_NUMBER
41        name: Annotate with pull request number
42        # This annotation is machine-readable and can be used to assign a check
43        # run to its corresponding pull request. Running in all check runs is
44        # required, because check re-runs discard the annotations of other
45        # tasks in the test suite.
46        run: |
47          if [ "${{ github.event_name }}" = "pull_request" ]; then
48            echo "::notice title=debug_pull_request_number_str::${{ github.event.number }}"
49          fi
50      - uses: actions/checkout@v6
51        with:
52          ref: ${{ github.event.pull_request.head.sha }}
53          fetch-depth: ${{ env.FETCH_DEPTH }}
54      - name: Determine commit range
55        run: |
56          # Checkout HEAD~ and find the test base commit.
57          # Checkout HEAD~ because it would be wasteful to rerun
58          # tests on the PR head commit that are already run
59          # by other jobs.
60          git checkout HEAD~
61          # Moreover, pull requests that contain a merge commit
62          # are generally draft pull requests that merge in other
63          # pull requests, so only check the relevant commits
64          # after the last merge commit. A merge commit could
65          # also be a subtree merge commit, which may be
66          # worthwhile to check. However, it is rare that the
67          # subtree merge commit is not the top commit (which
68          # would be skipped anyway by this task, because it is
69          # run by all other tasks). Also, `git rebase --exec`
70          # does not work on merge commits, so if this was
71          # important to check, the logic would have to be
72          # rewritten.
73          #
74          # Figure out test base commit by listing ancestors of
75          # HEAD, excluding ancestors of the most recent merge
76          # commit, ordering them from oldest to newest, and
77          # taking the first one.
78          #
79          # In the command below, the ^@ suffix is used to refer
80          # to all parents of the merge commit as described in:
81          # https://git-scm.com/docs/git-rev-parse#_other_rev_parent_shorthand_notations
82          # and the ^ prefix is used to exclude these parents
83          # and all their ancestors from the rev-list output
84          # as described in:
85          # https://git-scm.com/docs/git-rev-list
86          MERGE_BASE=$(git rev-list -n1 --merges HEAD)
87          EXCLUDE_MERGE_BASE_ANCESTORS=
88          # MERGE_BASE can be empty due to limited fetch-depth
89          if test -n "$MERGE_BASE"; then
90            EXCLUDE_MERGE_BASE_ANCESTORS=^${MERGE_BASE}^@
91          fi
92          echo "TEST_BASE=$(git rev-list -n${{ github.event.pull_request.commits }} --reverse HEAD $EXCLUDE_MERGE_BASE_ANCESTORS | head -1)" >> "$GITHUB_ENV"
93      - run: |
94          git fetch origin "${GITHUB_BASE_REF}"
95          git config user.email "[email protected]"
96          git config user.name "CI"
97      - run: |
98          sudo apt-get update
99          sudo apt-get install clang mold ccache build-essential cmake ninja-build pkgconf python3-zmq libboost-dev libsqlite3-dev systemtap-sdt-dev libzmq3-dev qt6-base-dev qt6-tools-dev qt6-l10n-tools libqrencode-dev capnproto libcapnp-dev -y
100          sudo pip3 install --break-system-packages pycapnp
101      - name: Compile and run tests
102        run: |
103          # Run tests on commits after the last merge commit and before the PR head commit
104          git rebase --exec "git merge --no-commit origin/${GITHUB_BASE_REF} && python3 ./.github/ci-test-each-commit-exec.py && git reset --hard" ${{ env.TEST_BASE }}
105
106  macos-native-arm64:
107    name: ${{ matrix.job-name }}
108    # Use any image to support the xcode-select below, but hardcode version to avoid silent upgrades (and breaks).
109    # See: https://github.com/actions/runner-images#available-images.
110    runs-on: macos-15
111
112    # When a contributor maintains a fork of the repo, any pull request they make
113    # to their own fork, or to the main repository, will trigger two CI runs:
114    # one for the branch push and one for the pull request.
115    # This can be avoided by setting SKIP_BRANCH_PUSH=true as a custom env variable
116    # in Github repository settings.
117    if: ${{ vars.SKIP_BRANCH_PUSH != 'true' || github.event_name == 'pull_request' }}
118
119    timeout-minutes: 120
120
121    strategy:
122      fail-fast: false
123      matrix:
124        job-type: [standard, fuzz]
125        include:
126          - job-type: standard
127            file-env: './ci/test/00_setup_env_mac_native.sh'
128            job-name: 'macOS native'
129          - job-type: fuzz
130            file-env: './ci/test/00_setup_env_mac_native_fuzz.sh'
131            job-name: 'macOS native, fuzz'
132
133    env:
134      DANGER_RUN_CI_ON_HOST: 1
135      BASE_ROOT_DIR: ${{ github.workspace }}/repo_archive
136
137    steps:
138      - *ANNOTATION_PR_NUMBER
139
140      - &CHECKOUT
141        name: Checkout
142        uses: actions/checkout@v6
143        with:
144          # Ensure the latest merged pull request state is used, even on re-runs.
145          ref: &CHECKOUT_REF_TMPL ${{ github.event_name == 'pull_request' && github.ref || '' }}
146
147      - name: Clang version
148        run: |
149          # Use the latest Xcode supported by the version of macOS denoted in
150          # doc/release-notes-empty-template.md and providing at least the
151          # minimum clang version denoted in doc/dependencies.md.
152          # See: https://developer.apple.com/documentation/xcode-release-notes/xcode-16_2-release-notes
153          sudo xcode-select --switch /Applications/Xcode_16.2.app
154          clang --version
155
156      - name: Install Homebrew packages
157        env:
158          HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
159        run: |
160          # A workaround for "The `brew link` step did not complete successfully" error.
161          brew install --quiet python@3 || brew link --overwrite python@3
162          brew install --quiet coreutils ninja pkgconf ccache boost zeromq qt@6 qrencode capnp
163
164      - name: Set Ccache directory
165        run: echo "CCACHE_DIR=${RUNNER_TEMP}/ccache_dir" >> "$GITHUB_ENV"
166
167      - name: Restore Ccache cache
168        id: ccache-cache
169        uses: actions/cache/restore@v5
170        with:
171          path: ${{ env.CCACHE_DIR }}
172          key: ${{ github.job }}-${{ matrix.job-type }}-ccache-${{ github.run_id }}
173          restore-keys: ${{ github.job }}-${{ matrix.job-type }}-ccache-
174
175      - name: Create git archive
176        run: |
177          git log -1
178          git archive --format=tar --prefix=repo_archive/ --output=repo.tar HEAD
179          tar -xf repo.tar
180
181      - name: CI script
182        run: |
183          cd repo_archive
184          ./ci/test_run_all.sh
185        env:
186          FILE_ENV: ${{ matrix.file-env }}
187
188      - name: Save Ccache cache
189        uses: actions/cache/save@v5
190        if: github.event_name != 'pull_request' && github.ref_name == github.event.repository.default_branch && steps.ccache-cache.outputs.cache-hit != 'true'
191        with:
192          path: ${{ env.CCACHE_DIR }}
193          # https://github.com/actions/cache/blob/main/tips-and-workarounds.md#update-a-cache
194          key: ${{ steps.ccache-cache.outputs.cache-primary-key }}
195
196  windows-native-dll:
197    name: ${{ matrix.job-name }}
198    runs-on: windows-2025-vs2026
199
200    if: ${{ vars.SKIP_BRANCH_PUSH != 'true' || github.event_name == 'pull_request' }}
201
202    env:
203      PYTHONUTF8: 1
204      TEST_RUNNER_TIMEOUT_FACTOR: 40
205
206    strategy:
207      fail-fast: false
208      matrix:
209        job-type: [standard, fuzz]
210        include:
211          - job-type: standard
212            job-name: 'Windows native, VS'
213          - job-type: fuzz
214            job-name: 'Windows native, fuzz, VS'
215
216    steps:
217      - *ANNOTATION_PR_NUMBER
218
219      - *CHECKOUT
220
221      - &IMPORT_VS_ENV
222        name: Import Visual Studio env vars
223        run: py -3 .github/ci-windows.py "standard" github_import_vs_env
224
225      - name: Get tool information
226        run: |
227          set -o errexit -o pipefail -o xtrace -o nounset
228
229          cmake -version | tee cmake_version
230          echo '---'
231          msbuild.exe -version | tee msbuild_version
232          echo "${VCToolsVersion-}" | tee toolset_version
233          py -3 --version
234          bash --version
235
236      - name: Restore vcpkg downloads cache
237        id: vcpkg-downloads-cache
238        uses: actions/cache/restore@v5
239        with:
240          path: |
241            ~/AppData/Local/vcpkg/downloads/*
242            !~/AppData/Local/vcpkg/downloads/tools
243          key: ${{ github.job }}-vcpkg-downloads-${{ hashFiles('vcpkg.json') }}
244
245      - name: Restore vcpkg binary cache
246        uses: actions/cache/restore@v5
247        id: vcpkg-binary-cache
248        with:
249          path: ~/AppData/Local/vcpkg/archives
250          key: ${{ github.job }}-vcpkg-binary-release-${{ hashFiles('cmake_version', 'msbuild_version', 'toolset_version', 'vcpkg.json') }}