Set environment variables before running rust-cache

Show how the related rustfmt action can be used.

.github/workflows/ci.yml

@@ -13,9 +13,28 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        rust: [nightly, beta, stable]
+        rust: [
+          # Test with toolchain file override
+          "1.50",
+          "nightly",
+          "beta",
+          "stable",
+        ]
     steps:
       - uses: actions/checkout@v3
+      # Test toolchain file support
+      - name: Write rust-toolchain.toml
+        run: |
+          cat <<EOF >>rust-toolchain.toml
+          [toolchain]
+          channel = "nightly-2020-07-10"
+          components = [ "rustfmt", "rustc-dev" ]
+          targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
+          profile = "minimal"
+          EOF
+        shell: bash
+        if: matrix.rust == '1.50'
+
       - uses: ./
         name: Run actions-rust-lang/setup-rust-toolchain ${{matrix.rust}}
         id: toolchain

CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.1] - 2022-07-29
+
+### Fixed
+
+* Set environment variables before invoking the cache action.
+    This ensures restoring and saving are using the same cache key.
+
+## [1.2.0] - 2022-07-21
+
+### Added
+
+* Prefer toolchain definitions in `rust-toolchain` or `rust-toolchain.toml` files ([Toolchain File](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file)).
+    Other input values are ignored if either file is found.
+
 ## [1.1.0] - 2022-07-19
 
 ### Added

README.md

@@ -24,11 +24,26 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions-rust-lang/setup-rust-toolchain@v1
       - run: cargo test --all-features
+ 
+  # Check formatting with rustfmt
+  formatting:
+    name: cargo fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Ensure rustfmt is installed and setup problem matcher
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          components: rustfmt
+      - name: Rustfmt Check
+        uses: actions-rust-lang/rustfmt@v1
 ```
 
 ## Inputs
 
 All inputs are optional.
+If a [toolchain file](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file) (i.e., `rust-toolchain` or `rust-toolchain.toml`) is found in the root of the repository, it takes precedence.
+All input values are ignored if a toolchain file exists.
 
 | Name         | Description                                                                       | Default |
 | ------------ | --------------------------------------------------------------------------------- | ------- |

action.yml

@@ -50,6 +50,19 @@ runs:
         targets: ${{inputs.target}}
         components: ${{inputs.components}}
       shell: bash
+    # The environment variables always need to be set before the caching action
+    - name: "Setting Environment Variables"
+      run: |
+        echo "CARGO_INCREMENTAL=0" >> $GITHUB_ENV
+        echo "CARGO_PROFILE_DEV_DEBUG=0" >> $GITHUB_ENV
+        echo "CARGO_TERM_COLOR=always" >> $GITHUB_ENV
+        echo "RUST_BACKTRACE=short" >> $GITHUB_ENV
+        echo "RUSTFLAGS=-D warnings" >> $GITHUB_ENV
+      shell: bash
+    - name: "Install Rust Problem Matcher"
+      run: echo "::add-matcher::${{ github.action_path }}/rust.json"
+      shell: bash
+
     - name: Install rustup, if needed
       run: |
         if ! command -v rustup &> /dev/null ; then
@@ -60,35 +73,31 @@ runs:
       shell: bash
     - name: rustup toolchain install ${{inputs.toolchain}}
       run: |
+        if [[ -f "rust-toolchain" || -f "rust-toolchain.toml" ]]
+        then
+          # Install the toolchain as specified in the file
+          # Might break at some point: https://github.com/rust-lang/rustup/issues/1397
+          rustup show
+        else
           rustup toolchain install ${{inputs.toolchain}}${{steps.flags.outputs.targets}}${{steps.flags.outputs.components}} --profile minimal${{steps.flags.outputs.downgrade}} --no-self-update
           rustup default ${{inputs.toolchain}}
+        fi
       shell: bash
 
     - name: Print installed versions
       id: versions
       run: |
-        echo "::set-output name=rustc-version::$(rustc +${{inputs.toolchain}} --version)"
-        rustc +${{inputs.toolchain}} --version --verbose
-        echo "::set-output name=cargo-version::$(cargo +${{inputs.toolchain}} --version)"
-        cargo +${{inputs.toolchain}} --version --verbose
-        echo "::set-output name=rustup-version::$(rustup +${{inputs.toolchain}} --version)"
-        rustup +${{inputs.toolchain}} --version
+        echo "::set-output name=rustc-version::$(rustc --version)"
+        rustc --version --verbose
+        echo "::set-output name=cargo-version::$(cargo --version)"
+        cargo --version --verbose
+        echo "::set-output name=rustup-version::$(rustup --version)"
+        rustup --version
 
-        DATE=$(rustc +${{inputs.toolchain}} --version --verbose | sed -ne 's/^commit-date: \(20[0-9][0-9]\)-\([01][0-9]\)-\([0-3][0-9]\)$/\1\2\3/p')
-        HASH=$(rustc +${{inputs.toolchain}} --version --verbose | sed -ne 's/^commit-hash: //p')
+        DATE=$(rustc --version --verbose | sed -ne 's/^commit-date: \(20[0-9][0-9]\)-\([01][0-9]\)-\([0-3][0-9]\)$/\1\2\3/p')
+        HASH=$(rustc --version --verbose | sed -ne 's/^commit-hash: //p')
         echo "::set-output name=cachekey::$(echo $DATE$HASH | head -c12)"
       shell: bash
 
     - name: "Setup Rust Caching"
       uses: Swatinem/rust-cache@v2
-    - name: "Install Rust Problem Matcher"
-      run: echo "::add-matcher::${{ github.action_path }}/rust.json"
-      shell: bash
-    - name: "Setting Environment Variables"
-      run: |
-        echo "CARGO_INCREMENTAL=0" >> $GITHUB_ENV
-        echo "CARGO_PROFILE_DEV_DEBUG=0" >> $GITHUB_ENV
-        echo "CARGO_TERM_COLOR=always" >> $GITHUB_ENV
-        echo "RUST_BACKTRACE=short" >> $GITHUB_ENV
-        echo "RUSTFLAGS=-D warnings" >> $GITHUB_ENV
-      shell: bash