setup-rust-toolchain/action.yml

name: Setup Rust Toolchain for GitHub CI
description: |
  Setup specific Rust versions with caching pre-configured.
  It provides problem matchers for cargo and rustfmt issues.

branding:
  icon: "play"
  color: "gray-dark"

# Add option to install directly from rust-toolchain file
# Blocked on rustup support: https://github.com/rust-lang/rustup/issues/2686
#
# The action is heavily inspired by https://github.com/dtolnay/rust-toolchain
inputs:
  toolchain:
    description: "Comma-separated list of Rust toolchain specifications. Last version becomes the default. -- see https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification"
    required: false
  target:
    description: "Target triple to install for this toolchain"
    required: false
  build-warnings:
    description: "Sets the build.warnings config via the CARGO_BUILD_WARNINGS variable."
    required: false
    default: "deny"
  components:
    description: "Comma-separated list of components to be additionally installed"
    required: false
  cache:
    description: "Automatically configure Rust cache"
    required: false
    default: "true"
  cache-workspaces:
    description: "Paths to multiple Cargo workspaces and their target directories, separated by newlines."
    required: false
  cache-directories:
    description: "Additional non workspace directories to be cached, separated by newlines."
    required: false
  cache-on-failure:
    description: "Cache even if the build fails."
    default: "true"
    required: false
  cache-key:
    description: "An additional cache key that is added alongside the automatic `job`-based cache key and can be used to further differentiate jobs."
    required: false
  cache-shared-key:
    description: "A cache key that is used instead of the automatic `job`-based key, and is stable over multiple jobs."
    required: false
  cache-bin:
    description: "Determines whether to cache ${CARGO_HOME}/bin."
    required: false
    default: "true"
  cache-provider:
    description: "Determines which provider to use for caching. Options are github, buildjet, or warpbuild. Defaults to github."
    required: false
    default: "github"
  cache-all-crates:
    description: "Determines which crates are cached. If `true` all crates will be cached, otherwise only dependent crates will be cached."
    required: false
    default: "false"
  cache-workspace-crates:
    description: "Determines which crates are cached. If `true` all crates will be cached, otherwise only dependent crates will be cached."
    required: false
    default: "false"
  cache-save-if:
    description: "Determines whether the cache should be saved. If `false`, the cache is only restored."
    required: false
    default: "true"
  cache-targets:
    description: "Determines whether workspace targets are cached. If `false`, only the cargo registry will be cached."
    required: false
    default: "true"
  matcher:
    description: "Enable the Rust problem matcher"
    required: false
    default: "true"
  rustflags:
    description: "set RUSTFLAGS environment variable, set to empty string to avoid overwriting build.rustflags"
    required: false
    default: ""
  override:
    description: "Setup the last installed toolchain as the default via `rustup override`"
    required: false
    default: "true"
  rust-src-dir:
    description: "Specify path from root directory to the Rust source directory. By default root directory will be used."
    required: false

outputs:
  rustc-version:
    description: "Version as reported by `rustc --version`"
    value: ${{steps.versions.outputs.rustc-version}}
  cargo-version:
    description: "Version as reported by `cargo --version`"
    value: ${{steps.versions.outputs.cargo-version}}
  rustup-version:
    description: "Version as reported by `rustup --version`"
    value: ${{steps.versions.outputs.rustup-version}}
  cachekey:
    description: A short hash of the rustc version, appropriate for use as a cache key. "20220627a831"
    value: ${{steps.versions.outputs.cachekey}}

# All local variables are using the `_srt_` prefix (for setup-rust-toolchain)
# this is to avoid conflicts with globally existing variables, as some names are quite generic (e.g., toolchain)
# This has caused issues in the past.
# https://github.com/actions-rust-lang/setup-rust-toolchain/issues/91
runs:
  using: composite
  steps:
    # The later code uses "newer" bash features, which are not available in the ancient bash 3 (from 2014) of macOS
    - name: Unbork mac
      if: runner.os == 'macOS'
      run: |
        brew install bash
      shell: bash

    - id: flags
      env:
        _srt_targets: ${{inputs.target}}
        _srt_components: ${{inputs.components}}
      shell: bash
      run: |
        : construct rustup command line
        echo "targets=$(for t in ${_srt_targets//,/ }; do echo -n ' --target' $t; done)" >> $GITHUB_OUTPUT
        echo "components=$(for c in ${_srt_components//,/ }; do echo -n ' --component' $c; done)" >> $GITHUB_OUTPUT
        echo "downgrade=${{contains(inputs.toolchain, 'nightly') && inputs.components && ' --allow-downgrade' || ''}}" >> $GITHUB_OUTPUT

    # The environment variables always need to be set before the caching action
    - name: Setting Environment Variables
      env:
        _srt_NEW_RUSTFLAGS: ${{inputs.rustflags}}
        _srt_CARGO_BUILD_WARNINGS: ${{inputs.build-warnings}}
      shell: bash
      run: |
        if [[ ! -v CARGO_INCREMENTAL ]]; then
          echo "CARGO_INCREMENTAL=0" >> $GITHUB_ENV
        fi
        if [[ ! -v CARGO_PROFILE_DEV_DEBUG ]]; then
          echo "CARGO_PROFILE_DEV_DEBUG=0" >> $GITHUB_ENV
        fi
        if [[ ! -v CARGO_TERM_COLOR ]]; then
          echo "CARGO_TERM_COLOR=always" >> $GITHUB_ENV
        fi
        if [[ ! -v RUST_BACKTRACE ]]; then
          echo "RUST_BACKTRACE=short" >> $GITHUB_ENV
        fi
        if [[ ( ! -v RUSTFLAGS ) && $_srt_NEW_RUSTFLAGS != "" ]]; then
          echo "RUSTFLAGS=$_srt_NEW_RUSTFLAGS" >> $GITHUB_ENV
        fi
        if [[ ( ! -v CARGO_BUILD_WARNINGS ) && $_srt_CARGO_BUILD_WARNINGS != "" ]]; then
          echo "CARGO_BUILD_WARNINGS=$_srt_CARGO_BUILD_WARNINGS" >> $GITHUB_ENV
        fi
        # Enable faster sparse index on nightly
        # The value is ignored on stable and causes no problems
        # https://internals.rust-lang.org/t/call-for-testing-cargo-sparse-registry/16862
        if [[ ! -v CARGO_UNSTABLE_SPARSE_REGISTRY ]]; then
          echo "CARGO_UNSTABLE_SPARSE_REGISTRY=true" >> $GITHUB_ENV
        fi
        if [[ ! -v CARGO_REGISTRIES_CRATES_IO_PROTOCOL ]]; then
          echo "CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse" >> $GITHUB_ENV
        fi

    - name: Install Rust Problem Matcher
      if: inputs.matcher == 'true'
      shell: bash
      run: echo "::add-matcher::${{ github.action_path }}/rust.json"

    - name: Install rustup, if needed
      shell: bash
      run: |
        if ! command -v rustup &> /dev/null ; then
          curl --proto '=https' --tlsv1.2 --retry 10 --retry-connrefused -fsSL "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y

          # Resolve the correct CARGO_HOME path depending on OS
          if [[ "$RUNNER_OS" == "Windows" ]]; then
            echo "${CARGO_HOME:-$USERPROFILE/.cargo}/bin" | sed 's|/|\\|g' >> $GITHUB_PATH
          else
            echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
          fi
        fi
      env:
        RUNNER_OS: "${{ runner.os }}"

    - name: rustup toolchain install ${{inputs.toolchain || 'stable'}}
      env:
        _srt_toolchain: ${{inputs.toolchain}}
        _srt_targets: ${{inputs.target}}
        _srt_components: ${{inputs.components}}
        _srt_override: ${{inputs.override}}
        _srt_rust_src_dir: ${{inputs.rust-src-dir}}
      shell: bash
      run: |
        # Check if value is set
        if [[ -n "$_srt_rust_src_dir" ]]
        then
          # If value is set the directory must exist
          if [[ -d "$_srt_rust_src_dir" ]]
          then
            cd "$_srt_rust_src_dir"
          else
            echo "'rust-src-dir' does not point to an existing directory" >&2
            echo "The value of 'rust-src-dir' is: ${_srt_rust_src_dir}" >&2
            exit 1
          fi
        fi
        if [[ -z "$_srt_toolchain" && ( -f "rust-toolchain" || -f "rust-toolchain.toml") ]]
        then
          # Install the toolchain as specified in the file
          # rustup show is the old way that implicitly installed a toolchain
          # rustup toolchain install is the new explicit way
          # https://github.com/rust-lang/rustup/issues/3635#issuecomment-2343511297
          rustup show active-toolchain || rustup toolchain install
          if [[ -n $_srt_components ]]; then
            rustup component add ${_srt_components//,/ }
          fi
          if [[ -n $_srt_targets ]]; then
            rustup target add ${_srt_targets//,/ }
          fi
        else
          if [[ -z "$_srt_toolchain" ]]
          then
            _srt_toolchain=stable
          fi
          rustup toolchain install ${_srt_toolchain//,/ } ${{steps.flags.outputs.targets}}${{steps.flags.outputs.components}} --profile minimal${{steps.flags.outputs.downgrade}} --no-self-update
          # Take the last element from the list
          if [[ "$_srt_override" == "true" ]]
          then
            rustup override set ${_srt_toolchain//*,/ }
          fi
        fi

    - id: versions
      name: Print installed versions
      shell: bash
      # Switch to the Rust sub-directory
      working-directory: ${{inputs.rust-src-dir || '.'}}
      run: |
        echo "rustc-version=$(rustc --version)" >> $GITHUB_OUTPUT
        _srt_VERBOSE=$(rustc --version --verbose)
        echo "$_srt_VERBOSE"
        echo "cargo-version=$(cargo --version)" >> $GITHUB_OUTPUT
        cargo --version --verbose
        echo "rustup-version=$(rustup --version)" >> $GITHUB_OUTPUT
        rustup --version

        _srt_DATE=$(echo "$_srt_VERBOSE" | sed -ne 's/^commit-date: \(20[0-9][0-9]\)-\([01][0-9]\)-\([0-3][0-9]\)$/\1\2\3/p')
        _srt_HASH=$(echo "$_srt_VERBOSE" | sed -ne 's/^commit-hash: //p')
        echo "cachekey=$(echo $_srt_DATE$_srt_HASH | head -c12)" >> $GITHUB_OUTPUT

    - name: Downgrade registry access protocol when needed
      shell: bash
      run: |
        # Not all versions support setting CARGO_REGISTRIES_CRATES_IO_PROTOCOL
        # On versions 1.66, 1.67, and 1.68.0-nightly the value "sparse" is still unstable.
        # https://github.com/dtolnay/rust-toolchain/pull/69#discussion_r1107268108
        # If we detect an incompatible value, set it to "git" which is always supported.
        if [[ "${{steps.versions.outputs.rustc-version}}" =~ ^rustc\ (1\.6[67]\.|1\.68\.0-nightly) && "${CARGO_REGISTRIES_CRATES_IO_PROTOCOL}" == "sparse" ]]; then
          echo "Downgrade cargo registry protocol to git"
          echo "CARGO_REGISTRIES_CRATES_IO_PROTOCOL=git" >> $GITHUB_ENV
        fi

    - name: Setup Rust Caching
      if: inputs.cache == 'true'
      uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
      with:
        workspaces: ${{ inputs.cache-workspaces || inputs.rust-src-dir }}
        cache-directories: ${{inputs.cache-directories}}
        cache-on-failure: ${{inputs.cache-on-failure}}
        cache-bin: ${{inputs.cache-bin}}
        cache-provider: ${{inputs.cache-provider}}
        cache-all-crates: ${{inputs.cache-all-crates}}
        cache-workspace-crates: ${{inputs.cache-workspace-crates}}
        cache-targets: ${{inputs.cache-targets}}
        save-if: ${{inputs.cache-save-if}}
        key: ${{inputs.cache-key}}
        shared-key: ${{inputs.cache-shared-key}}