Merge pull request #34 from actions-rust-lang/rel-180

Using rustup override set will override a local rust-toolchain.toml file
while rustup default will not.

.github/workflows/autotag-releases.yml

@@ -15,7 +15,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Get version from tag
         id: tag_name
         run: |

.github/workflows/ci.yml

@@ -1,60 +1,106 @@
-
 name: CI
 
 on:
-  push:
+  push: { branches: [main] }
   pull_request:
   schedule: [cron: "40 1 * * *"]
 
 jobs:
   install:
-    name: Rust ${{matrix.rust}}
-    runs-on: ubuntu-latest
+    name: Rust ${{matrix.rust || '(default)'}} (toolchain-file=${{matrix.write-toolchain-file}}) (${{matrix.os}})
+    runs-on: ${{matrix.os}}
     strategy:
       fail-fast: false
+      max-parallel: 5
       matrix:
-        rust: [
-          # Test with toolchain file override
-          "1.60",
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        write-toolchain-file:
+          - false
+          - true
+        rust:
+          # use stable toolchain as default
+          - null
+
           # Test that the sparse registry check works.
           # 1.66 and 1.67 don't support stable sparse registry.
-          "1.66",
-          "nightly",
-          "beta",
-          "stable",
-        ]
+          - "1.66"
+
+          - "nightly"
+          - "beta"
+          - "stable"
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
       # Test toolchain file support
       - name: Write rust-toolchain.toml
+        if: matrix.write-toolchain-file
+        shell: bash
         run: |
           cat <<EOF >>rust-toolchain.toml
           [toolchain]
-          channel = "nightly-2022-09-10"
+          channel = "nightly-2024-01-10"
           components = [ "rustfmt", "rustc-dev" ]
-          targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
+          targets = [ "wasm32-unknown-unknown", "thumbv7m-none-eabi" ]
           profile = "minimal"
           EOF
-        shell: bash
-        if: matrix.rust == '1.60'
 
-      - uses: ./
-        name: Run actions-rust-lang/setup-rust-toolchain ${{matrix.rust}}
-        id: toolchain
+      - id: toolchain
+        name: Run actions-rust-lang/setup-rust-toolchain ${{matrix.rust || 'on toolchain file'}}
+        uses: ./
         with:
           toolchain: ${{matrix.rust}}
+          components: clippy
+
       - name: Check ${{'${{steps.toolchain.outputs.rustc-version}}'}}
         run: echo '${{steps.toolchain.outputs.rustc-version}}'
+
       - name: Check ${{'${{steps.toolchain.outputs.cargo-version}}'}}
         run: echo '${{steps.toolchain.outputs.cargo-version}}'
+
       - name: Check ${{'${{steps.toolchain.outputs.rustup-version}}'}}
         run: echo '${{steps.toolchain.outputs.rustup-version}}'
-      - run: rustc --version && cargo --version
+
+      - name: Check lack of toolchain input or file results in stable
+        if: matrix.write-toolchain-file == false && matrix.rust == null
         shell: bash
+        run: |-
+          rustcv="$(rustc --version)"
+          [[ "$rustcv" != *"nightly"* && "$rustcv" != *"beta"* ]]
+
+      - name: Check toolchain file is being overridden
+        if: matrix.write-toolchain-file
+        shell: bash
+        run: |-
+          rustcv="$(rustc --version)"
+          [[ ! ( "$rustcv" == *"nightly"* && "$rustcv" == *"2024-01-10"* ) ]]
+
+      - shell: bash
+        run: rustc --version && cargo --version
 
       # Test with creating a small project
       - run: cargo init . --bin --name ci
+
       # Add tiny empty crate.
       # This checks that registry access works.
       - run: cargo add serde_as
-      - run: cargo check
+
+      - run: cargo clippy
+
+  cache:
+    name: Cache
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: ./
+        with:
+          components: clippy
+          cache: true
+          cache-workspaces: |-
+            ./test-workspace
+
+      - run: cargo clippy --manifest-path=./test-workspace/Cargo.toml

CHANGELOG.md

@@ -5,6 +5,73 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.8.0] - 2024-01-13
+
+* Allow specifying subdirectories for cache.
+* Fix toolchain file overriding.
+
+## [1.7.0] - 2024-01-11
+
+* Allow overriding the toolchain file with explicit `toolchain` input. (#26)
+
+## [1.6.0] - 2023-12-04
+
+### Added
+
+* Allow disabling problem matchers (#27)
+    This can be useful when having a matrix of jobs, that produce the same errors.
+
+## [1.5.0] - 2023-05-29
+
+### Added
+
+* Support installing additional components and targets that are not listed in `rust-toolchain` (#14)
+    Before only the items listed in `rust-toolchain` were installed.
+    Now all the items from the toolchain file are installed and then all the `target`s and `components` that are provided as action inputs.
+    This allows installing extra tools only for CI or simplify testing special targets in CI.
+* Allow skipping the creation of a `RUSTFLAGS` environment variable.
+    Cargos logic for rustflags is complicated, and setting the `RUSTFLAGS` environment variable prevents other ways of working.
+    Provide a new `rustflags` input, which controls the environment variable creation.
+    If the value is set to the empty string, then `RUSTFLAGS` is not created.
+
+    Pre-existing `RUSTFLAGS` variables are never modified by this extension.
+
+## [1.4.4] - 2023-03-18
+
+### Fixed
+
+* Use color aware problem matcher.
+    The problem matcher currently runs against the colored terminal output ([Bug 1](https://github.com/actions/runner/issues/2341), [Bug 2](https://github.com/actions/runner/pull/2430)).
+    The previous matcher was not aware of ANSII color codes and did not work.
+
+## [1.4.3] - 2023-02-21
+
+### Fixed
+
+* Executing the action twice for different toolchains now no longer fails around unstable features #12.
+    If multiple toolchains are installed, the "CARGO_REGISTRIES_CRATES_IO_PROTOCOL" can be downgraded to "git" if any of the installed toolchains require it.
+
+## [1.4.2] - 2023-02-15
+
+### Fixed
+
+* Tweak sparse registry version regex to better work with 1.68 nightly versions.
+* Fix command not found issue
+
+## [1.4.1] - 2023-02-13
+
+### Fixed
+
+* Fixed running on macOS #9 #10
+    The macOS images have an ancient version of bash, but the action relies on "newer" features than 2014.
+    We install bash via brew (already pre-installed) to have a new enough version.
+
+    The CI is extended to also run on Windows and macOS to catch such issues earlier in the future.
+
+    Thanks to @GeorgeHahn for reporting the issue.
+
 ## [1.4.0] - 2023-02-13
 
 ### Changed

README.md

@@ -21,16 +21,16 @@ jobs:
     name: cargo test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - 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
+      - uses: actions/checkout@v4
       # Ensure rustfmt is installed and setup problem matcher
       - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -42,23 +42,45 @@ jobs:
 ## 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.
+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 and no `toolchain` value is provided, all items specified in the toolchain file will be installed.
+If a `toolchain` value is provided, the toolchain file will be ignored.
+If no `toolchain` value or toolchain file is present, it will default to `stable`.
+First, all items specified in the toolchain file are installed.
+Afterward, the `components` and `target` specified via inputs are installed in addition to the items from the toolchain file.
 
-| Name         | Description                                                                       | Default |
-| ------------ | --------------------------------------------------------------------------------- | ------- |
-| `toolchain`  | Rustup toolchain specifier e.g. `stable`, `nightly`, `1.42.0`.                    | stable  |
-| `target`     | Additional target support to install e.g. `wasm32-unknown-unknown`                |         |
-| `components` | Comma-separated string of additional components to install e.g. `clippy, rustfmt` |         |
-| `cache`      | Automatically configure Rust cache (using `Swatinem/rust-cache`)                  | true    |
+| Name               | Description                                                                            | Default       |
+|--------------------|----------------------------------------------------------------------------------------|---------------|
+| `toolchain`        | Rustup toolchain specifier e.g. `stable`, `nightly`, `1.42.0`.                         | stable        |
+| `target`           | Additional target support to install e.g. `wasm32-unknown-unknown`                     |               |
+| `components`       | Comma-separated string of additional components to install e.g. `clippy, rustfmt`      |               |
+| `cache`            | Automatically configure Rust cache (using `Swatinem/rust-cache`)                       | true          |
+| `cache-workspaces` | Propagates the value to `Swatinem/rust-cache`                                          |               |
+| `matcher`          | Enable problem matcher to surface build messages and formatting issues                 | true          |
+| `rustflags`        | Set the value of `RUSTFLAGS` (set to empty string to avoid overwriting existing flags) | "-D warnings" |
+
+### RUSTFLAGS
+
+By default, this action sets the `RUSTFLAGS` environment variable to `-D warnings`.
+However, rustflags sources are mutually exclusive, so setting this environment variable omits any configuration through `target.*.rustflags` or `build.rustflags`.
+
+* If `RUSTFLAGS` is already set, no modifications of the variable are made and the original value remains.
+* If `RUSTFLAGS` is unset and the `rustflags` input is empty (i.e., the empty string), then it will remain unset.
+    Use this, if you want to prevent the value from being set because you make use of `target.*.rustflags` or `build.rustflags`.
+* Otherwise, the environment variable `RUSTFLAGS` is set to the content of `rustflags`.
+
+To prevent this from happening, set the `rustflags` input to an empty string, which will
+prevent the action from setting `RUSTFLAGS` at all, keeping any existing preferences.
+
+You can read more rustflags, and their load order, in the [Cargo reference].
 
 ## Outputs
 
-| Name             | Description                               |
-| ---------------- | ----------------------------------------- |
-| `rustc-version`  | Version as reported by `rustc --version`  |
-| `cargo-version`  | Version as reported by `cargo --version`  |
-| `rustup-version` | Version as reported by `rustup --version` |
+| Name             | Description                                 |
+| ---------------- | ------------------------------------------- |
+| `rustc-version`  | Version as reported by `rustc --version`    |
+| `cargo-version`  | Version as reported by `cargo --version`    |
+| `rustup-version` | Version as reported by `rustup --version`   |
+| `cachekey`       | A short hash of the installed rustc version |
 
 ## License
 
@@ -67,3 +89,4 @@ License].
 
 [MIT License]: LICENSE
 [Problem Matchers]: https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md
+[Cargo reference]: https://doc.rust-lang.org/cargo/reference/config.html?highlight=unknown#buildrustflags

action.yml

@@ -15,7 +15,6 @@ inputs:
   toolchain:
     description: "Rust toolchain specification -- see https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification"
     required: false
-    default: "stable"
   target:
     description: "Target triple to install for this toolchain"
     required: false
@@ -26,6 +25,17 @@ inputs:
     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
+  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: "-D warnings"
 
 outputs:
   rustc-version:
@@ -44,18 +54,29 @@ outputs:
 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:
+        targets: ${{inputs.target}}
+        components: ${{inputs.components}}
+      shell: bash
       run: |
         : construct rustup command line
         echo "targets=$(for t in ${targets//,/ }; do echo -n ' --target' $t; done)" >> $GITHUB_OUTPUT
         echo "components=$(for c in ${components//,/ }; do echo -n ' --component' $c; done)" >> $GITHUB_OUTPUT
         echo "downgrade=${{inputs.toolchain == 'nightly' && inputs.components && ' --allow-downgrade' || ''}}" >> $GITHUB_OUTPUT
-      env:
-        targets: ${{inputs.target}}
-        components: ${{inputs.components}}
-      shell: bash
+
     # The environment variables always need to be set before the caching action
-    - name: "Setting Environment Variables"
+    - name: Setting Environment Variables
+      env:
+        NEW_RUSTFLAGS: ${{inputs.rustflags}}
+      shell: bash
       run: |
         if [[ ! -v CARGO_INCREMENTAL ]]; then
           echo "CARGO_INCREMENTAL=0" >> $GITHUB_ENV
@@ -69,8 +90,8 @@ runs:
         if [[ ! -v RUST_BACKTRACE ]]; then
           echo "RUST_BACKTRACE=short" >> $GITHUB_ENV
         fi
-        if [[ ! -v RUSTFLAGS ]]; then
-          echo "RUSTFLAGS=-D warnings" >> $GITHUB_ENV
+        if [[ ( ! -v RUSTFLAGS ) && $NEW_RUSTFLAGS != "" ]]; then
+          echo "RUSTFLAGS=$NEW_RUSTFLAGS" >> $GITHUB_ENV
         fi
         # Enable faster sparse index on nightly
         # The value is ignored on stable and causes no problems
@@ -78,34 +99,54 @@ runs:
         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
-    - name: "Install Rust Problem Matcher"
       run: echo "::add-matcher::${{ github.action_path }}/rust.json"
-      shell: bash
 
     - name: Install rustup, if needed
+      if: runner.os != 'Windows'
+      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
           echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
         fi
-      if: runner.os != 'Windows'
+
+    - name: rustup toolchain install ${{inputs.toolchain || 'stable'}}
+      env:
+        toolchain: ${{inputs.toolchain}}
+        targets: ${{inputs.target}}
+        components: ${{inputs.components}}
       shell: bash
-    - name: rustup toolchain install ${{inputs.toolchain}}
       run: |
-        if [[ -f "rust-toolchain" || -f "rust-toolchain.toml" ]]
+        if [[ -z "$toolchain" && ( -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
+          if [[ -n $components ]]; then
+            rustup component add ${components//,/ }
+          fi
+          if [[ -n $targets ]]; then
+            rustup target add ${targets//,/ }
+          fi
         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}}
+          if [[ -z "$toolchain" ]]
+          then
+            toolchain=stable
+          fi
+          rustup toolchain install $toolchain${{steps.flags.outputs.targets}}${{steps.flags.outputs.components}} --profile minimal${{steps.flags.outputs.downgrade}} --no-self-update
+          rustup override set $toolchain
         fi
-      shell: bash
 
-    - name: Print installed versions
-      id: versions
+    - id: versions
+      name: Print installed versions
+      shell: bash
       run: |
         echo "rustc-version=$(rustc --version)" >> $GITHUB_OUTPUT
         rustc --version --verbose
@@ -117,20 +158,21 @@ runs:
         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 "cachekey=$(echo $DATE$HASH | head -c12)" >> $GITHUB_OUTPUT
-      shell: bash
 
-    # Copied from dtolnay/rust-toolchain and adapted
-    # https://github.com/dtolnay/rust-toolchain/blob/25dc93b901a87e864900a8aec6c12e9aa794c0c3/action.yml#L100-L108
-    - name: "Enable cargo sparse registry on stable"
+    - name: Downgrade registry access protocol when needed
+      shell: bash
       run: |
-        # except on 1.66 and 1.67, on which it is unstable
-        if [[ ! -v CARGO_REGISTRIES_CRATES_IO_PROTOCOL ]]; then
-          if echo "${{steps.versions.outputs.rustc-version}}" | not grep -q '^rustc 1\.6[67]\.'; then
-            echo "CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse" >> $GITHUB_ENV
-          fi
+        # 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
-      shell: bash
 
-    - name: "Setup Rust Caching"
+    - name: Setup Rust Caching
       if: inputs.cache == 'true'
       uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: ${{inputs.cache-workspaces}}

rust.json

@@ -16,16 +16,16 @@
             "owner": "clippy",
             "pattern": [
                 {
-                    "regexp": "^(warning|warn|error)(\\[(.*)\\])?: (.*)$",
+                    "regexp": "^(?:\\x1b\\[[\\d;]+m)*(warning|warn|error)(?:\\x1b\\[[\\d;]+m)*(\\[(.*)\\])?(?:\\x1b\\[[\\d;]+m)*:(?:\\x1b\\[[\\d;]+m)* ([^\\x1b]*)(?:\\x1b\\[[\\d;]+m)*$",
                     "severity": 1,
                     "message": 4,
                     "code": 3
                 },
                 {
-                    "regexp": "^([\\s->=]*(.*):(\\d*):(\\d*)|.*)$",
-                    "file": 2,
-                    "line": 3,
-                    "column": 4
+                    "regexp": "^(?:\\x1b\\[[\\d;]+m)*\\s*(?:\\x1b\\[[\\d;]+m)*\\s*--> (?:\\x1b\\[[\\d;]+m)*(.*):(\\d*):(\\d*)(?:\\x1b\\[[\\d;]+m)*$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3
                 }
             ]
         }

test-workspace/Cargo.lock

@@ -0,0 +1,16 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "ci"
+version = "0.1.0"
+dependencies = [
+ "serde_as",
+]
+
+[[package]]
+name = "serde_as"
+version = "0.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ee4afe4c5c3b69699c4267ae42b838e911466d7ca0005046adc93ac95bb16dd"

test-workspace/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "ci"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+serde_as = "0.0.1"

test-workspace/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}