[workflows] Rework pre-commit CI for the release branch #91550
Conversation
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
|
@llvm/pr-subscribers-github-workflow Author: Tom Stellard (tstellar) ChangesThis rewrites the pre-commit CI for the release branch so that it behaves almost exactly like the current buildkite builders. It builds every project and uses a better filtering method for selecting which projects to build. In addition, with this change we drop the Linux and Windows test configs, since these are already covered by buildkite and add a config for macos/aarch64. Patch is 25.87 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/91550.diff 10 Files Affected:
diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
new file mode 100644
index 0000000000000..22e39174abee7
--- /dev/null
+++ b/.github/workflows/ci-tests.yml
@@ -0,0 +1,154 @@
+name: "CI Tests"
+
+permissions:
+ contents: read
+
+on:
+ pull_request:
+ types:
+ - opened
+ - synchronize
+ - reopened
+ # When a PR is closed, we still start this workflow, but then skip
+ # all the jobs, which makes it effectively a no-op. The reason to
+ # do this is that it allows us to take advantage of concurrency groups
+ # to cancel in progress CI jobs whenever the PR is closed.
+ - closed
+ branches:
+ - main
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+ cancel-in-progress: True
+
+jobs:
+ compute-test-configs:
+ name: "Compute Configurations to Test"
+ if: github.event.action != 'closed'
+ runs-on: ubuntu-22.04
+ outputs:
+ projects: ${{ steps.vars.outputs.projects }}
+ check-targets: ${{ steps.vars.outputs.check-targets }}
+ test-build: ${{ steps.vars.outputs.check-targets != '' }}
+ test-platforms: ${{ steps.platforms.outputs.result }}
+ steps:
+ - name: Fetch LLVM sources
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 2
+
+ - name: Compute projects to test
+ id: vars
+ uses: ./.github/workflows/compute-projects-to-test
+
+ - name: Compute platforms to test
+ uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea #v7.0.1
+ id: platforms
+ with:
+ script: |
+ linuxConfig = {
+ name: "linux-x86_64",
+ runs_on: "ubuntu-22.04"
+ }
+ windowsConfig = {
+ name: "windows-x86_64",
+ runs_on: "windows-2022"
+ }
+ macConfig = {
+ name: "macos-x86_64",
+ runs_on: "macos-13"
+ }
+ macArmConfig = {
+ name: "macos-aarch64",
+ runs_on: "macos-14"
+ }
+
+ configs = []
+
+ const base_ref = process.env.GITHUB_BASE_REF;
+ if (base_ref.startsWith('release/')) {
+ // This is a pull request against a release branch.
+ configs.push(macConfig)
+ configs.push(macArmConfig)
+ }
+
+ return configs;
+
+ ci-build-test:
+ # If this job name is changed, then we need to update the job-name
+ # paramater for the timeout-save step below.
+ name: "Build"
+ needs:
+ - compute-test-configs
+ permissions:
+ actions: write #pr-sccache-save may delete artifacts.
+ runs-on: ${{ matrix.runs_on }}
+ strategy:
+ fail-fast: false
+ matrix:
+ include: ${{ fromJson(needs.compute-test-configs.outputs.test-platforms) }}
+ if: needs.compute-test-configs.outputs.test-build == 'true'
+ steps:
+ - name: Fetch LLVM sources
+ uses: actions/checkout@v4
+
+ - name: Timeout Restore
+ id: timeout
+ uses: ./.github/workflows/timeout-restore
+ with:
+ artifact-name-suffix: ${{ matrix.name }}
+
+ - name: Setup Windows
+ uses: llvm/actions/setup-windows@main
+ if: ${{ runner.os == 'Windows' }}
+ with:
+ arch: amd64
+
+ - name: Install Ninja
+ uses: llvm/actions/install-ninja@main
+
+ - name: Setup sccache
+ uses: hendrikmuhs/ccache-action@v1
+ with:
+ max-size: 2G
+ variant: sccache
+ key: ci-${{ matrix.name }}
+
+ - name: Restore sccache from previous PR run
+ uses: ./.github/workflows/pr-sccache-restore
+ with:
+ artifact-name-suffix: ${{ matrix.name }}
+
+ - name: Configure
+ if: ${{ steps.timeout.outputs.exists != 'true' }}
+ shell: bash
+ run: |
+ cmake -B build -GNinja \
+ -DCMAKE_BUILD_TYPE=Release \
+ -DLLVM_ENABLE_PROJECTS="${{ needs.compute-test-configs.outputs.projects }}" \
+ -DLLVM_ENABLE_ASSERTIONS=ON \
+ -DLLVM_LIT_ARGS="-v --no-progress-bar" \
+ -DCMAKE_C_COMPILER_LAUNCHER=sccache \
+ -DCMAKE_CXX_COMPILER_LAUNCHER=sccache \
+ -S llvm
+
+ - name: Build
+ shell: bash
+ timeout-minutes: 330
+ run: |
+ ninja -C build -k 0 ${{ needs.compute-test-configs.outputs.check-targets }}
+
+ - name: Timeout Save
+ if: always()
+ uses: ./.github/workflows/timeout-save
+ with:
+ job-name: "Build (${{ matrix.name }}, ${{ matrix.runs_on }})"
+ artifact-name-suffix: ${{ matrix.name }}
+ timeout-step: "Build"
+ timeout-minutes: 330
+
+ - name: Save sccache for next PR run
+ if: always()
+ uses: ./.github/workflows/pr-sccache-save
+ with:
+ artifact-name-suffix: ${{ matrix.name }}
diff --git a/.github/workflows/compute-projects-to-test/action.yml b/.github/workflows/compute-projects-to-test/action.yml
new file mode 100644
index 0000000000000..37df06c8c301c
--- /dev/null
+++ b/.github/workflows/compute-projects-to-test/action.yml
@@ -0,0 +1,21 @@
+name: 'Compute Projects To Test'
+inputs:
+ projects:
+ required: false
+ type: 'string'
+
+outputs:
+ check-targets:
+ description: "A space delimited list of check-targets to pass to ninja."
+ value: ${{ steps.compute-projects.outputs.check-targets }}
+
+ projects:
+ description: "A semi-colon delimited list of projects to pass to -DLLVM_ENABLE_PROJECTS."
+ value: ${{ steps.compute-projects.outputs.projects }}
+
+runs:
+ using: "composite"
+ steps:
+ - id: compute-projects
+ run: .github/workflows/compute-projects-to-test/compute-projects-to-test.sh ${{ inputs.projects }}
+ shell: bash
diff --git a/.github/workflows/compute-projects-to-test/compute-projects-to-test.sh b/.github/workflows/compute-projects-to-test/compute-projects-to-test.sh
new file mode 100755
index 0000000000000..4cfbda0c82034
--- /dev/null
+++ b/.github/workflows/compute-projects-to-test/compute-projects-to-test.sh
@@ -0,0 +1,221 @@
+#!/usr/bin/env bash
+#===----------------------------------------------------------------------===##
+#
+# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+#===----------------------------------------------------------------------===##
+
+#
+# This file generates a Buildkite pipeline that triggers the various CI jobs for
+# the LLVM project during pre-commit CI.
+#
+# See https://buildkite.com/docs/agent/v3/cli-pipeline#pipeline-format.
+#
+# As this outputs a yaml file, it's possible to log messages to stderr or
+# prefix with "#".
+
+
+set -eu
+set -o pipefail
+
+# Environment variables script works with:
+
+# Set by GitHub
+: ${GITHUB_OUTPUT:=}
+: ${RUNNER_OS:=}
+
+# Allow users to specify which projects to build.
+all_projects="bolt clang clang-tools-extra compiler-rt cross-project-tests flang libc libclc lld lldb llvm mlir openmp polly pstl"
+if [ "$#" -ne 0 ]; then
+ wanted_projects="${@}"
+else
+ wanted_projects="${all_projects}"
+fi
+
+# List of files affected by this commit
+: ${MODIFIED_FILES:=$(git diff --name-only HEAD~1...HEAD)}
+
+echo "Files modified:" >&2
+echo "$MODIFIED_FILES" >&2
+modified_dirs=$(echo "$MODIFIED_FILES" | cut -d'/' -f1 | sort -u)
+echo "Directories modified:" >&2
+echo "$modified_dirs" >&2
+echo "wanted_projects: $wanted_projects"
+
+function remove-unwanted-projects() {
+ projects=${@}
+ for project in ${projects}; do
+ if echo "$wanted_projects" | tr ' ' '\n' | grep -q -E "^${project}$"; then
+ echo "${project}"
+ fi
+ done
+}
+
+function compute-projects-to-test() {
+ projects=${@}
+ for project in ${projects}; do
+ echo "${project}"
+ case ${project} in
+ lld)
+ for p in bolt cross-project-tests; do
+ echo $p
+ done
+ ;;
+ llvm)
+ for p in bolt clang clang-tools-extra flang lld lldb mlir polly; do
+ echo $p
+ done
+ ;;
+ clang)
+ for p in clang-tools-extra compiler-rt flang libc lldb openmp cross-project-tests; do
+ echo $p
+ done
+ ;;
+ clang-tools-extra)
+ echo libc
+ ;;
+ mlir)
+ echo flang
+ ;;
+ *)
+ # Nothing to do
+ ;;
+ esac
+ done
+}
+
+function add-dependencies() {
+ projects=${@}
+ for project in ${projects}; do
+ echo "${project}"
+ case ${project} in
+ bolt)
+ for p in lld llvm; do
+ echo $p
+ done
+ ;;
+ cross-project-tests)
+ for p in lld clang; do
+ echo $p
+ done
+ ;;
+ clang-tools-extra)
+ for p in llvm clang; do
+ echo $p
+ done
+ ;;
+ compiler-rt|libc|openmp)
+ echo clang lld
+ ;;
+ flang|lldb)
+ for p in llvm clang; do
+ echo $p
+ done
+ ;;
+ lld|mlir|polly)
+ echo llvm
+ ;;
+ *)
+ # Nothing to do
+ ;;
+ esac
+ done
+}
+
+function exclude-linux() {
+ projects=${@}
+ for project in ${projects}; do
+ case ${project} in
+ cross-project-tests) ;; # tests failing
+ lldb) ;; # tests failing
+ openmp) ;; # https://github.com/google/llvm-premerge-checks/issues/410
+ *)
+ echo "${project}"
+ ;;
+ esac
+ done
+}
+
+function exclude-windows() {
+ projects=${@}
+ for project in ${projects}; do
+ case ${project} in
+ cross-project-tests) ;; # tests failing
+ compiler-rt) ;; # tests taking too long
+ openmp) ;; # TODO: having trouble with the Perl installation
+ libc) ;; # no Windows support
+ lldb) ;; # tests failing
+ bolt) ;; # tests are not supported yet
+ *)
+ echo "${project}"
+ ;;
+ esac
+ done
+}
+
+# Prints only projects that are both present in $modified_dirs and the passed
+# list.
+function keep-modified-projects() {
+ projects=${@}
+ for project in ${projects}; do
+ if echo "$modified_dirs" | grep -q -E "^${project}$"; then
+ echo "${project}"
+ fi
+ done
+}
+
+function check-targets() {
+ projects=${@}
+ for project in ${projects}; do
+ case ${project} in
+ clang-tools-extra)
+ echo "check-clang-tools"
+ ;;
+ compiler-rt)
+ echo "check-all"
+ ;;
+ cross-project-tests)
+ echo "check-cross-project"
+ ;;
+ lldb)
+ echo "check-all" # TODO: check-lldb may not include all the LLDB tests?
+ ;;
+ pstl)
+ echo "check-all"
+ ;;
+ libclc)
+ echo "check-all"
+ ;;
+ *)
+ echo "check-${project}"
+ ;;
+ esac
+ done
+}
+
+# Generic pipeline for projects that have not defined custom steps.
+#
+# Individual projects should instead define the pre-commit CI tests that suits their
+# needs while letting them run on the infrastructure provided by LLVM.
+
+# Figure out which projects need to be built on each platform
+modified_projects="$(keep-modified-projects ${all_projects})"
+echo "modified_projects: $modified_projects"
+
+if [ "${RUNNER_OS}" = "Linux" ]; then
+ projects_to_test=$(exclude-linux $(compute-projects-to-test ${modified_projects}))
+elif [ "${RUNNER_OS}" = "Windows" ]; then
+ projects_to_test=$(exclude-windows $(compute-projects-to-test ${modified_projects}))
+else
+ echo "Unknown runner OS: $RUNNER_OS"
+ exit 1
+fi
+check_targets=$(check-targets $(remove-unwanted-projects ${projects_to_test}) | sort | uniq)
+projects=$(remove-unwanted-projects $(add-dependencies ${projects_to_test}) | sort | uniq)
+
+echo "check-targets=$(echo ${check_targets} | tr ' ' ' ')" >> $GITHUB_OUTPUT
+echo "projects=$(echo ${projects} | tr ' ' ';')" >> $GITHUB_OUTPUT
+
+cat $GITHUB_OUTPUT
diff --git a/.github/workflows/continue-timeout-job.yml b/.github/workflows/continue-timeout-job.yml
new file mode 100644
index 0000000000000..f3ff58c77cfe0
--- /dev/null
+++ b/.github/workflows/continue-timeout-job.yml
@@ -0,0 +1,75 @@
+name: Continue Timeout Job
+
+on:
+ workflow_run:
+ workflows:
+ - "Windows Precommit Tests"
+ - "CI Tests"
+ types:
+ - completed
+
+permissions:
+ contents: read
+
+jobs:
+ restart:
+ name: "Restart Job"
+ permissions:
+ actions: write
+ runs-on: ubuntu-22.04
+ if: github.event.workflow_run.conclusion == 'failure'
+ steps:
+ - name: "Restart Job"
+ uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea #v7.0.1
+ with:
+ script: |
+ const response = await github.rest.actions.listWorkflowRunArtifacts({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: context.payload.workflow_run.id
+ })
+
+ job_ids = [];
+
+ for (artifact of response.data.artifacts) {
+ console.log(artifact);
+ const match = artifact.name.match(/timeout-([0-9]+)/);
+ console.log(match);
+ if (!match) {
+ continue;
+ }
+ job_ids.push(match[1]);
+
+ // Delete the timeout artifact to prepare for the next run
+ await github.rest.actions.deleteArtifact({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ artifact_id: artifact.id
+ });
+ }
+
+ if (job_ids.length == 0) {
+ return;
+ }
+
+ if (job_ids.length > 1) {
+ // We aren't able to re-start multiple jobs individually, so our
+ // only option is to restart all failed jobs.
+ await github.rest.actions.reRunWorkflowFailedJobs({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: context.payload.workflow_run.id
+ })
+ console.log("Restarted workflow: " + context.payload.workflow_run.id);
+ return;
+ }
+
+ job_id = job_ids[0];
+ // This function does not exist even though it is in the document
+ //github.rest.actions.reRunJobForWorkflow({
+ await github.request('POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun', {
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ job_id: job_id
+ })
+ console.log("Restarted job: " + job_id);
diff --git a/.github/workflows/get-job-id/action.yml b/.github/workflows/get-job-id/action.yml
new file mode 100644
index 0000000000000..65495efd86820
--- /dev/null
+++ b/.github/workflows/get-job-id/action.yml
@@ -0,0 +1,30 @@
+name: Get Job ID
+inputs:
+ job-name:
+ required: false
+ type: 'string'
+
+outputs:
+ job-id:
+ description: "A space delimited list of check-targets to pass to ninja."
+ value: ${{ steps.job-id.outputs.result }}
+
+runs:
+ using: "composite"
+ steps:
+ - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea #v7.0.1
+ id: job-id
+ with:
+ script: |
+ const job_data = await github.rest.actions.listJobsForWorkflowRun({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: context.runId,
+ });
+
+ for (job of job_data.data.jobs) {
+ console.log(job)
+ if (job.name == "${{ inputs.job-name }}") {
+ return job.id
+ }
+ }
diff --git a/.github/workflows/pr-sccache-restore/action.yml b/.github/workflows/pr-sccache-restore/action.yml
new file mode 100644
index 0000000000000..8aa87025ba54b
--- /dev/null
+++ b/.github/workflows/pr-sccache-restore/action.yml
@@ -0,0 +1,26 @@
+name: PR sccache restore
+
+inputs:
+ artifact-name-suffix:
+ desciption: The suffix to append to the artifict name (sccache-pr#)
+ required: true
+
+runs:
+ using: "composite"
+ steps:
+ - uses: ./.github/workflows/unprivileged-download-artifact
+ id: download-artifact
+ with:
+ artifact-name: sccache-pr${{ github.event.pull_request.number }}-${{ inputs.artifact-name-suffix }}
+
+ - shell: bash
+ if: steps.download-artifact.outputs.filename != ''
+ run: |
+ # Is this the best way to clear the cache?
+ rm -Rf .sccache/
+ unzip ${{ steps.download-artifact.outputs.filename }}
+ rm ${{ steps.download-artifact.outputs.filename }}
+ tar --zstd -xf sccache.tar.zst
+ rm sccache.tar.zst
+ ls -altr
+
diff --git a/.github/workflows/pr-sccache-save/action.yml b/.github/workflows/pr-sccache-save/action.yml
new file mode 100644
index 0000000000000..ee46e1df9605e
--- /dev/null
+++ b/.github/workflows/pr-sccache-save/action.yml
@@ -0,0 +1,50 @@
+name: PR sccache save
+inputs:
+ artifact-name-suffix:
+ desciption: The suffix to append to the artifict name (sccache-pr#)
+ required: true
+
+runs:
+ using: "composite"
+ steps:
+ - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea #v7.0.1
+ with:
+ script: |
+ const data = await github.rest.actions.listWorkflowRunArtifacts({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: context.runId,
+ name: 'sccache-pr' + context.issue.number + "-${{ inputs.artifact-name-suffix }}"
+ })
+
+ console.log(data.data.artifacts)
+ if (data.data.artifacts.length == 0) {
+ return '';
+ }
+ console.log(data.data.artifacts[0])
+ const artifact_id = data.data.artifacts[0].id
+
+ // Delete the exisiting artifact so we can upload a new one with the same name.
+ github.rest.actions.deleteArtifact({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ artifact_id: artifact_id
+ })
+
+ - name: Package sccache Directory
+ shell: bash
+ run: |
+ # Dereference symlinks so that this works on Windows.
+ tar -h -c .sccache | zstd -T0 -c > sccache.tar.zst
+
+ - uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 #v4.3.0
+ with:
+ name: 'sccache-pr${{ github.event.number }}-${{ inputs.artifact-name-suffix }}'
+ path: sccache.tar.zst
+ retention-days: 7
+
+ - shell: bash
+ run: |
+ rm sccache.tar.zst
+ sccache --show-stats
+
diff --git a/.github/workflows/timeout-restore/action.yml b/.github/workflows/timeout-restore/action.yml
new file mode 100644
index 0000000000000..417782ccc5ca1
--- /dev/null
+++ b/.github/workflows/timeout-restore/action.yml
@@ -0,0 +1,33 @@
+name: Timeout Restore
+description: Save build state from a timed out job.
+inputs:
+ artifact-name-suffix:
+ desciption: Suffix to add to the name of the artifact containing the build state.
+ required: true
+
+outputs:
+ exists:
+ description: "This is true if a previous timeout build was restored, false otherwise."
+ value: ${{ steps.timeout-artifact.exists }}
+
+runs:
+ using: "composite"
+ steps:
+ - name: Download Artifact
+ uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935 # v4.1.1
+ with:
+ pattern: timeout-build-${{ inputs.artifact-name-suffix }}
+ merge-multiple: true
+
+ - name: Unpack Artifact
+ id: timeout-artifact
+ shell: bash
+ run: |
+ if [ -e llvm-project.tar.zst ]; then
+ tar --zstd -xf llvm-project.tar.zst
+ rm llvm-project.tar.zst
+ echo "exists=true" >> $GITHUB_OUTPUT
+ else
+ echo "exists=false" >> $GITHUB_OUTPUT
+ fi
+
diff --git a/.github/workflows/timeout-save/action.yml b/.github/workflows/timeout-save/action.yml
new file mode 100644
index 0000000000000..fcea59165cf30
--- /dev/null
+++ b/.github/workflows/timeout-save/action.yml
@@ -0,0 +1,94 @@
+name: Timeout Save
+description: Save build state when a timeout occurs so that it can be reused when the job is restarted.
+inputs:
+ job-name:
+ description: The name of the job. This is used to look up the job id.
+ required: true
+ artifact-name-suffix:
+ desciption: Suffix to add to the name of the artifact containing the build state.
+ required: true
+ timeout-step:
+ description: The step that w...
[truncated]
|
This rewrites the pre-commit CI for the release branch so that it behaves almost exactly like the current buildkite builders. It builds every project and uses a better filtering method for selecting which projects to build. In addition, with this change we drop the Linux and Windows test configs, since these are already covered by buildkite and add a config for macos/aarch64.
tstellar
force-pushed
the
precommit-release-pr-18
branch
from
a590088
to
8ea4c39
Compare
|
This PR is for testing purposes only, the main PR is here: #92058 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This rewrites the pre-commit CI for the release branch so that it behaves almost exactly like the current buildkite builders. It builds every project and uses a better filtering method for selecting which projects to build.
In addition, with this change we drop the Linux and Windows test configs, since these are already covered by buildkite and add a config for macos/aarch64.