Merge pull request #15 from actions-rust-lang/fix-problem-matcher

The action runner currently fails to strip color codes from the output.
This means that many matchers currectly do not work.

https://github.com/actions/runner/issues/2341
https://github.com/actions/runner/pull/2430

The new matcher is copied from kaj/rsass which is MIT licensed.

3e5d6c0600/.github/workflows/rust-problem-matcher.json

.github/workflows/ci.yml

@@ -8,18 +8,26 @@ on:
 
 jobs:
   install:
-    name: Rust ${{matrix.rust}}
+    name: Rust ${{matrix.rust}} ${{matrix.os}}
-    runs-on: ubuntu-latest
+    runs-on: ${{matrix.os}}
     strategy:
       fail-fast: false
       matrix:
         rust: [
           # Test with toolchain file override
-          "1.50",
+          "1.60",
+          # Test that the sparse registry check works.
+          # 1.66 and 1.67 don't support stable sparse registry.
+          "1.66",
           "nightly",
           "beta",
           "stable",
         ]
+        os: [
+          "ubuntu-latest",
+          "windows-latest",
+          "macos-latest",
+        ]
     steps:
       - uses: actions/checkout@v3
       # Test toolchain file support
@@ -27,13 +35,13 @@ jobs:
         run: |
           cat <<EOF >>rust-toolchain.toml
           [toolchain]
-          channel = "nightly-2020-07-10"
+          channel = "nightly-2022-09-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.50'
+        if: matrix.rust == '1.60'
 
       - uses: ./
         name: Run actions-rust-lang/setup-rust-toolchain ${{matrix.rust}}
@@ -48,3 +56,10 @@ jobs:
         run: echo '${{steps.toolchain.outputs.rustup-version}}'
       - run: rustc --version && cargo --version
         shell: bash
+
+      # 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

CHANGELOG.md

@@ -7,6 +7,63 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+* Only set environment variables, if they are not set before.
+    This allows setting environment variables before using this action and keeping their values.
+* Enable stable sparse registry, except on versions 1.66 and 1.67 where this leads to errors.
+
+## [1.3.7] - 2023-01-31
+
+### Fixed
+
+* Disable the stable access to the sparse registry.
+    Setting the value causes problem on version before stabilization, e.g., 1.67.
+    For example, "cargo add" fails.
+
+## [1.3.6] - 2023-01-31
+
+### Fixed
+
+* The the correct environment variable to enable the sparse registry access.
+    The pull request originally had the wrong value, without `CARGO_` prefix.
+
 ## [1.3.5] - 2023-01-21
 
 ### Changed

action.yml

@@ -44,6 +44,13 @@ 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
       run: |
         : construct rustup command line
@@ -57,17 +64,30 @@ runs:
     # The environment variables always need to be set before the caching action
     - name: "Setting Environment Variables"
       run: |
-        echo "CARGO_INCREMENTAL=0" >> $GITHUB_ENV
+        if [[ ! -v CARGO_INCREMENTAL ]]; then
-        echo "CARGO_PROFILE_DEV_DEBUG=0" >> $GITHUB_ENV
+          echo "CARGO_INCREMENTAL=0" >> $GITHUB_ENV
-        echo "CARGO_TERM_COLOR=always" >> $GITHUB_ENV
+        fi
-        echo "RUST_BACKTRACE=short" >> $GITHUB_ENV
+        if [[ ! -v CARGO_PROFILE_DEV_DEBUG ]]; then
-        echo "RUSTFLAGS=-D warnings" >> $GITHUB_ENV
+          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 ]]; then
+          echo "RUSTFLAGS=-D 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
-        echo "CARGO_UNSTABLE_SPARSE_REGISTRY=true" >> $GITHUB_ENV
+        if [[ ! -v CARGO_UNSTABLE_SPARSE_REGISTRY ]]; then
-        # Enable sparse index after stabilization
+          echo "CARGO_UNSTABLE_SPARSE_REGISTRY=true" >> $GITHUB_ENV
-        # https://github.com/rust-lang/cargo/pull/11224
+        fi
-        echo "REGISTRIES_CRATES_IO_PROTOCOL=sparse" >> $GITHUB_ENV
+        if [[ ! -v CARGO_REGISTRIES_CRATES_IO_PROTOCOL ]]; then
+          echo "CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse" >> $GITHUB_ENV
+        fi
       shell: bash
     - name: "Install Rust Problem Matcher"
       run: echo "::add-matcher::${{ github.action_path }}/rust.json"
@@ -109,6 +129,18 @@ runs:
         echo "cachekey=$(echo $DATE$HASH | head -c12)" >> $GITHUB_OUTPUT
       shell: bash
 
+    - name: "Downgrade registry access protocol when needed"
+      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
+      shell: bash
+
     - name: "Setup Rust Caching"
       if: inputs.cache == 'true'
       uses: Swatinem/rust-cache@v2

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*)|.*)$",
+                    "regexp": "^(?:\\x1b\\[[\\d;]+m)*\\s*(?:\\x1b\\[[\\d;]+m)*\\s*--> (?:\\x1b\\[[\\d;]+m)*(.*):(\\d*):(\\d*)(?:\\x1b\\[[\\d;]+m)*$",
-                    "file": 2,
+                    "file": 1,
-                    "line": 3,
+                    "line": 2,
-                    "column": 4
+                    "column": 3
                 }
             ]
         }