One-shot Terminal Titles #17615
This file contains hidden or 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: rust-ci | |
| on: | |
| pull_request: {} | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| # CI builds in debug (dev) for faster signal. | |
| jobs: | |
| # --- Detect what changed to detect which tests to run (always runs) ------------------------------------- | |
| changed: | |
| name: Detect changed areas | |
| runs-on: ubuntu-24.04 | |
| outputs: | |
| codex: ${{ steps.detect.outputs.codex }} | |
| workflows: ${{ steps.detect.outputs.workflows }} | |
| steps: | |
| - uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Detect changed paths (no external action) | |
| id: detect | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| if [[ "${{ github.event_name }}" == "pull_request" ]]; then | |
| BASE_SHA='${{ github.event.pull_request.base.sha }}' | |
| HEAD_SHA='${{ github.event.pull_request.head.sha }}' | |
| echo "Base SHA: $BASE_SHA" | |
| echo "Head SHA: $HEAD_SHA" | |
| # List files changed between base and PR head | |
| mapfile -t files < <(git diff --name-only --no-renames "$BASE_SHA" "$HEAD_SHA") | |
| else | |
| # On push / manual runs, default to running everything | |
| files=("codex-rs/force" ".github/force") | |
| fi | |
| codex=false | |
| workflows=false | |
| for f in "${files[@]}"; do | |
| [[ $f == codex-rs/* ]] && codex=true | |
| [[ $f == .github/* ]] && workflows=true | |
| done | |
| echo "codex=$codex" >> "$GITHUB_OUTPUT" | |
| echo "workflows=$workflows" >> "$GITHUB_OUTPUT" | |
| # --- CI that doesn't need specific targets --------------------------------- | |
| general: | |
| name: Format / etc | |
| runs-on: ubuntu-24.04 | |
| needs: changed | |
| if: ${{ needs.changed.outputs.codex == 'true' || needs.changed.outputs.workflows == 'true' || github.event_name == 'push' }} | |
| defaults: | |
| run: | |
| working-directory: codex-rs | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: dtolnay/[email protected] | |
| with: | |
| components: rustfmt | |
| - name: cargo fmt | |
| run: cargo fmt -- --config imports_granularity=Item --check | |
| - name: Verify codegen for mcp-types | |
| run: ./mcp-types/check_lib_rs.py | |
| cargo_shear: | |
| name: cargo shear | |
| runs-on: ubuntu-24.04 | |
| needs: changed | |
| if: ${{ needs.changed.outputs.codex == 'true' || needs.changed.outputs.workflows == 'true' || github.event_name == 'push' }} | |
| defaults: | |
| run: | |
| working-directory: codex-rs | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: dtolnay/[email protected] | |
| - uses: taiki-e/install-action@44c6d64aa62cd779e873306675c7a58e86d6d532 # v2 | |
| with: | |
| tool: cargo-shear | |
| version: 1.5.1 | |
| - name: cargo shear | |
| run: cargo shear | |
| # --- CI to validate on different os/targets -------------------------------- | |
| lint_build: | |
| name: Lint/Build — ${{ matrix.runner }} - ${{ matrix.target }}${{ matrix.profile == 'release' && ' (release)' || '' }} | |
| runs-on: ${{ matrix.runner }} | |
| timeout-minutes: 30 | |
| needs: changed | |
| # Keep job-level if to avoid spinning up runners when not needed | |
| if: ${{ needs.changed.outputs.codex == 'true' || needs.changed.outputs.workflows == 'true' || github.event_name == 'push' }} | |
| defaults: | |
| run: | |
| working-directory: codex-rs | |
| env: | |
| # Speed up repeated builds across CI runs by caching compiled objects (non-Windows). | |
| USE_SCCACHE: ${{ startsWith(matrix.runner, 'windows') && 'false' || 'true' }} | |
| CARGO_INCREMENTAL: "0" | |
| SCCACHE_CACHE_SIZE: 10G | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - runner: macos-14 | |
| target: aarch64-apple-darwin | |
| profile: dev | |
| - runner: macos-14 | |
| target: x86_64-apple-darwin | |
| profile: dev | |
| - runner: ubuntu-24.04 | |
| target: x86_64-unknown-linux-musl | |
| profile: dev | |
| - runner: ubuntu-24.04 | |
| target: x86_64-unknown-linux-gnu | |
| profile: dev | |
| - runner: ubuntu-24.04-arm | |
| target: aarch64-unknown-linux-musl | |
| profile: dev | |
| - runner: ubuntu-24.04-arm | |
| target: aarch64-unknown-linux-gnu | |
| profile: dev | |
| - runner: windows-latest | |
| target: x86_64-pc-windows-msvc | |
| profile: dev | |
| - runner: windows-11-arm | |
| target: aarch64-pc-windows-msvc | |
| profile: dev | |
| # Also run representative release builds on Mac and Linux because | |
| # there could be release-only build errors we want to catch. | |
| # Hopefully this also pre-populates the build cache to speed up | |
| # releases. | |
| - runner: macos-14 | |
| target: aarch64-apple-darwin | |
| profile: release | |
| - runner: ubuntu-24.04 | |
| target: x86_64-unknown-linux-musl | |
| profile: release | |
| - runner: windows-latest | |
| target: x86_64-pc-windows-msvc | |
| profile: release | |
| - runner: windows-11-arm | |
| target: aarch64-pc-windows-msvc | |
| profile: release | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: dtolnay/[email protected] | |
| with: | |
| targets: ${{ matrix.target }} | |
| components: clippy | |
| - name: Compute lockfile hash | |
| id: lockhash | |
| working-directory: codex-rs | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| echo "hash=$(sha256sum Cargo.lock | cut -d' ' -f1)" >> "$GITHUB_OUTPUT" | |
| echo "toolchain_hash=$(sha256sum rust-toolchain.toml | cut -d' ' -f1)" >> "$GITHUB_OUTPUT" | |
| # Explicit cache restore: split cargo home vs target, so we can | |
| # avoid caching the large target dir on the gnu-dev job. | |
| - name: Restore cargo home cache | |
| id: cache_cargo_home_restore | |
| uses: actions/cache/restore@v5 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| key: cargo-home-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ steps.lockhash.outputs.toolchain_hash }} | |
| restore-keys: | | |
| cargo-home-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}- | |
| # Install and restore sccache cache | |
| - name: Install sccache | |
| if: ${{ env.USE_SCCACHE == 'true' }} | |
| uses: taiki-e/install-action@44c6d64aa62cd779e873306675c7a58e86d6d532 # v2 | |
| with: | |
| tool: sccache | |
| version: 0.7.5 | |
| - name: Configure sccache backend | |
| if: ${{ env.USE_SCCACHE == 'true' }} | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| if [[ -n "${ACTIONS_CACHE_URL:-}" && -n "${ACTIONS_RUNTIME_TOKEN:-}" ]]; then | |
| echo "SCCACHE_GHA_ENABLED=true" >> "$GITHUB_ENV" | |
| echo "Using sccache GitHub backend" | |
| else | |
| echo "SCCACHE_GHA_ENABLED=false" >> "$GITHUB_ENV" | |
| echo "SCCACHE_DIR=${{ github.workspace }}/.sccache" >> "$GITHUB_ENV" | |
| echo "Using sccache local disk + actions/cache fallback" | |
| fi | |
| - name: Enable sccache wrapper | |
| if: ${{ env.USE_SCCACHE == 'true' }} | |
| shell: bash | |
| run: echo "RUSTC_WRAPPER=sccache" >> "$GITHUB_ENV" | |
| - name: Restore sccache cache (fallback) | |
| if: ${{ env.USE_SCCACHE == 'true' && env.SCCACHE_GHA_ENABLED != 'true' }} | |
| id: cache_sccache_restore | |
| uses: actions/cache/restore@v5 | |
| with: | |
| path: ${{ github.workspace }}/.sccache/ | |
| key: sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ github.run_id }} | |
| restore-keys: | | |
| sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}- | |
| sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}- | |
| - if: ${{ matrix.target == 'x86_64-unknown-linux-musl' || matrix.target == 'aarch64-unknown-linux-musl'}} | |
| name: Prepare APT cache directories (musl) | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| sudo mkdir -p /var/cache/apt/archives /var/lib/apt/lists | |
| sudo chown -R "$USER:$USER" /var/cache/apt /var/lib/apt/lists | |
| - if: ${{ matrix.target == 'x86_64-unknown-linux-musl' || matrix.target == 'aarch64-unknown-linux-musl'}} | |
| name: Restore APT cache (musl) | |
| id: cache_apt_restore | |
| uses: actions/cache/restore@v5 | |
| with: | |
| path: | | |
| /var/cache/apt | |
| key: apt-${{ matrix.runner }}-${{ matrix.target }}-v1 | |
| - if: ${{ matrix.target == 'x86_64-unknown-linux-musl' || matrix.target == 'aarch64-unknown-linux-musl'}} | |
| name: Install musl build tools | |
| env: | |
| DEBIAN_FRONTEND: noninteractive | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| sudo apt-get -y update -o Acquire::Retries=3 | |
| sudo apt-get -y install --no-install-recommends musl-tools pkg-config | |
| - name: Install cargo-chef | |
| if: ${{ matrix.profile == 'release' }} | |
| uses: taiki-e/install-action@44c6d64aa62cd779e873306675c7a58e86d6d532 # v2 | |
| with: | |
| tool: cargo-chef | |
| version: 0.1.71 | |
| - name: Pre-warm dependency cache (cargo-chef) | |
| if: ${{ matrix.profile == 'release' }} | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| RECIPE="${RUNNER_TEMP}/chef-recipe.json" | |
| cargo chef prepare --recipe-path "$RECIPE" | |
| cargo chef cook --recipe-path "$RECIPE" --target ${{ matrix.target }} --release --all-features | |
| - name: cargo clippy | |
| id: clippy | |
| run: cargo clippy --target ${{ matrix.target }} --all-features --tests --profile ${{ matrix.profile }} -- -D warnings | |
| # Running `cargo build` from the workspace root builds the workspace using | |
| # the union of all features from third-party crates. This can mask errors | |
| # where individual crates have underspecified features. To avoid this, we | |
| # run `cargo check` for each crate individually, though because this is | |
| # slower, we only do this for the x86_64-unknown-linux-gnu target. | |
| - name: cargo check individual crates | |
| id: cargo_check_all_crates | |
| if: ${{ matrix.target == 'x86_64-unknown-linux-gnu' && matrix.profile != 'release' }} | |
| continue-on-error: true | |
| run: | | |
| find . -name Cargo.toml -mindepth 2 -maxdepth 2 -print0 \ | |
| | xargs -0 -n1 -I{} bash -c 'cd "$(dirname "{}")" && cargo check --profile ${{ matrix.profile }}' | |
| # Save caches explicitly; make non-fatal so cache packaging | |
| # never fails the overall job. Only save when key wasn't hit. | |
| - name: Save cargo home cache | |
| if: always() && !cancelled() && steps.cache_cargo_home_restore.outputs.cache-hit != 'true' | |
| continue-on-error: true | |
| uses: actions/cache/save@v5 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| key: cargo-home-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ steps.lockhash.outputs.toolchain_hash }} | |
| - name: Save sccache cache (fallback) | |
| if: always() && !cancelled() && env.USE_SCCACHE == 'true' && env.SCCACHE_GHA_ENABLED != 'true' | |
| continue-on-error: true | |
| uses: actions/cache/save@v5 | |
| with: | |
| path: ${{ github.workspace }}/.sccache/ | |
| key: sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ github.run_id }} | |
| - name: sccache stats | |
| if: always() && env.USE_SCCACHE == 'true' | |
| continue-on-error: true | |
| run: sccache --show-stats || true | |
| - name: sccache summary | |
| if: always() && env.USE_SCCACHE == 'true' | |
| shell: bash | |
| run: | | |
| { | |
| echo "### sccache stats — ${{ matrix.target }} (${{ matrix.profile }})"; | |
| echo; | |
| echo '```'; | |
| sccache --show-stats || true; | |
| echo '```'; | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| - name: Save APT cache (musl) | |
| if: always() && !cancelled() && (matrix.target == 'x86_64-unknown-linux-musl' || matrix.target == 'aarch64-unknown-linux-musl') && steps.cache_apt_restore.outputs.cache-hit != 'true' | |
| continue-on-error: true | |
| uses: actions/cache/save@v5 | |
| with: | |
| path: | | |
| /var/cache/apt | |
| key: apt-${{ matrix.runner }}-${{ matrix.target }}-v1 | |
| # Fail the job if any of the previous steps failed. | |
| - name: verify all steps passed | |
| if: | | |
| steps.clippy.outcome == 'failure' || | |
| steps.cargo_check_all_crates.outcome == 'failure' | |
| run: | | |
| echo "One or more checks failed (clippy or cargo_check_all_crates). See logs for details." | |
| exit 1 | |
| tests: | |
| name: Tests — ${{ matrix.runner }} - ${{ matrix.target }} | |
| runs-on: ${{ matrix.runner }} | |
| timeout-minutes: 30 | |
| needs: changed | |
| if: ${{ needs.changed.outputs.codex == 'true' || needs.changed.outputs.workflows == 'true' || github.event_name == 'push' }} | |
| defaults: | |
| run: | |
| working-directory: codex-rs | |
| env: | |
| # Speed up repeated builds across CI runs by caching compiled objects (non-Windows). | |
| USE_SCCACHE: ${{ startsWith(matrix.runner, 'windows') && 'false' || 'true' }} | |
| CARGO_INCREMENTAL: "0" | |
| SCCACHE_CACHE_SIZE: 10G | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - runner: macos-14 | |
| target: aarch64-apple-darwin | |
| profile: dev | |
| - runner: ubuntu-24.04 | |
| target: x86_64-unknown-linux-gnu | |
| profile: dev | |
| - runner: ubuntu-24.04-arm | |
| target: aarch64-unknown-linux-gnu | |
| profile: dev | |
| - runner: windows-latest | |
| target: x86_64-pc-windows-msvc | |
| profile: dev | |
| - runner: windows-11-arm | |
| target: aarch64-pc-windows-msvc | |
| profile: dev | |
| steps: | |
| - uses: actions/checkout@v6 | |
| # We have been running out of space when running this job on Linux for | |
| # x86_64-unknown-linux-gnu, so remove some unnecessary dependencies. | |
| - name: Remove unnecessary dependencies to save space | |
| if: ${{ startsWith(matrix.runner, 'ubuntu') }} | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| sudo rm -rf \ | |
| /usr/local/lib/android \ | |
| /usr/share/dotnet \ | |
| /usr/local/share/boost \ | |
| /usr/local/lib/node_modules \ | |
| /opt/ghc | |
| sudo apt-get remove -y docker.io docker-compose podman buildah | |
| # Some integration tests rely on DotSlash being installed. | |
| # See https://github.com/openai/codex/pull/7617. | |
| - name: Install DotSlash | |
| uses: facebook/install-dotslash@v2 | |
| - uses: dtolnay/[email protected] | |
| with: | |
| targets: ${{ matrix.target }} | |
| - name: Compute lockfile hash | |
| id: lockhash | |
| working-directory: codex-rs | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| echo "hash=$(sha256sum Cargo.lock | cut -d' ' -f1)" >> "$GITHUB_OUTPUT" | |
| echo "toolchain_hash=$(sha256sum rust-toolchain.toml | cut -d' ' -f1)" >> "$GITHUB_OUTPUT" | |
| - name: Restore cargo home cache | |
| id: cache_cargo_home_restore | |
| uses: actions/cache/restore@v5 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| key: cargo-home-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ steps.lockhash.outputs.toolchain_hash }} | |
| restore-keys: | | |
| cargo-home-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}- | |
| - name: Install sccache | |
| if: ${{ env.USE_SCCACHE == 'true' }} | |
| uses: taiki-e/install-action@44c6d64aa62cd779e873306675c7a58e86d6d532 # v2 | |
| with: | |
| tool: sccache | |
| version: 0.7.5 | |
| - name: Configure sccache backend | |
| if: ${{ env.USE_SCCACHE == 'true' }} | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| if [[ -n "${ACTIONS_CACHE_URL:-}" && -n "${ACTIONS_RUNTIME_TOKEN:-}" ]]; then | |
| echo "SCCACHE_GHA_ENABLED=true" >> "$GITHUB_ENV" | |
| echo "Using sccache GitHub backend" | |
| else | |
| echo "SCCACHE_GHA_ENABLED=false" >> "$GITHUB_ENV" | |
| echo "SCCACHE_DIR=${{ github.workspace }}/.sccache" >> "$GITHUB_ENV" | |
| echo "Using sccache local disk + actions/cache fallback" | |
| fi | |
| - name: Enable sccache wrapper | |
| if: ${{ env.USE_SCCACHE == 'true' }} | |
| shell: bash | |
| run: echo "RUSTC_WRAPPER=sccache" >> "$GITHUB_ENV" | |
| - name: Restore sccache cache (fallback) | |
| if: ${{ env.USE_SCCACHE == 'true' && env.SCCACHE_GHA_ENABLED != 'true' }} | |
| id: cache_sccache_restore | |
| uses: actions/cache/restore@v5 | |
| with: | |
| path: ${{ github.workspace }}/.sccache/ | |
| key: sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ github.run_id }} | |
| restore-keys: | | |
| sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}- | |
| sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}- | |
| - uses: taiki-e/install-action@44c6d64aa62cd779e873306675c7a58e86d6d532 # v2 | |
| with: | |
| tool: nextest | |
| version: 0.9.103 | |
| - name: tests | |
| id: test | |
| run: cargo nextest run --all-features --no-fail-fast --target ${{ matrix.target }} --cargo-profile ci-test | |
| env: | |
| RUST_BACKTRACE: 1 | |
| NEXTEST_STATUS_LEVEL: leak | |
| - name: Save cargo home cache | |
| if: always() && !cancelled() && steps.cache_cargo_home_restore.outputs.cache-hit != 'true' | |
| continue-on-error: true | |
| uses: actions/cache/save@v5 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| key: cargo-home-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ steps.lockhash.outputs.toolchain_hash }} | |
| - name: Save sccache cache (fallback) | |
| if: always() && !cancelled() && env.USE_SCCACHE == 'true' && env.SCCACHE_GHA_ENABLED != 'true' | |
| continue-on-error: true | |
| uses: actions/cache/save@v5 | |
| with: | |
| path: ${{ github.workspace }}/.sccache/ | |
| key: sccache-${{ matrix.runner }}-${{ matrix.target }}-${{ matrix.profile }}-${{ steps.lockhash.outputs.hash }}-${{ github.run_id }} | |
| - name: sccache stats | |
| if: always() && env.USE_SCCACHE == 'true' | |
| continue-on-error: true | |
| run: sccache --show-stats || true | |
| - name: sccache summary | |
| if: always() && env.USE_SCCACHE == 'true' | |
| shell: bash | |
| run: | | |
| { | |
| echo "### sccache stats — ${{ matrix.target }} (tests)"; | |
| echo; | |
| echo '```'; | |
| sccache --show-stats || true; | |
| echo '```'; | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| - name: verify tests passed | |
| if: steps.test.outcome == 'failure' | |
| run: | | |
| echo "Tests failed. See logs for details." | |
| exit 1 | |
| # --- Gatherer job that you mark as the ONLY required status ----------------- | |
| results: | |
| name: CI results (required) | |
| needs: [changed, general, cargo_shear, lint_build, tests] | |
| if: always() | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Summarize | |
| shell: bash | |
| run: | | |
| echo "general: ${{ needs.general.result }}" | |
| echo "shear : ${{ needs.cargo_shear.result }}" | |
| echo "lint : ${{ needs.lint_build.result }}" | |
| echo "tests : ${{ needs.tests.result }}" | |
| # If nothing relevant changed (PR touching only root README, etc.), | |
| # declare success regardless of other jobs. | |
| if [[ '${{ needs.changed.outputs.codex }}' != 'true' && '${{ needs.changed.outputs.workflows }}' != 'true' && '${{ github.event_name }}' != 'push' ]]; then | |
| echo 'No relevant changes -> CI not required.' | |
| exit 0 | |
| fi | |
| # Otherwise require the jobs to have succeeded | |
| [[ '${{ needs.general.result }}' == 'success' ]] || { echo 'general failed'; exit 1; } | |
| [[ '${{ needs.cargo_shear.result }}' == 'success' ]] || { echo 'cargo_shear failed'; exit 1; } | |
| [[ '${{ needs.lint_build.result }}' == 'success' ]] || { echo 'lint_build failed'; exit 1; } | |
| [[ '${{ needs.tests.result }}' == 'success' ]] || { echo 'tests failed'; exit 1; } | |
| - name: sccache summary note | |
| if: always() | |
| run: | | |
| echo "Per-job sccache stats are attached to each matrix job's Step Summary." |