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/autotag-releases.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Get version from tag
         id: tag_name
         run: |
-          echo ::set-output name=current_version::${GITHUB_REF#refs/tags/}
+          echo "current_version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
         shell: bash
       - name: Create and push tags
         run: |

.github/workflows/ci.yml

@@ -8,14 +8,41 @@ on:
 
 jobs:
   install:
-    name: Rust ${{matrix.rust}}
-    runs-on: ubuntu-latest
+    name: Rust ${{matrix.rust}} ${{matrix.os}}
+    runs-on: ${{matrix.os}}
     strategy:
       fail-fast: false
       matrix:
-        rust: [nightly, beta, stable]
+        rust: [
+          # Test with toolchain file override
+          "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
+      - name: Write rust-toolchain.toml
+        run: |
+          cat <<EOF >>rust-toolchain.toml
+          [toolchain]
+          channel = "nightly-2022-09-10"
+          components = [ "rustfmt", "rustc-dev" ]
+          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
@@ -29,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,119 @@ 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
+
+* Use the newly stabilized setting to enable sparse registry access.
+    This speeds up access to the crate registry and is in addition to the unstable nightly env var.
+    <https://github.com/rust-lang/cargo/pull/11224>
+
+## [1.3.4] - 2022-10-15
+
+### Changed
+
+* The last version did not fix all "set-output" commands
+
+## [1.3.3] - 2022-10-13
+
+### Changed
+
+* Switch from set-output to $GITHUB_OUTPUT to avoid warning
+    https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
+
+## [1.3.2] - 2022-09-15
+
+### Fixed
+
+* Fix setting `$CARGO_HOME` to a valid path, in case rustup is installed from the internet.
+    Thanks to @nahsi for providing the fix.
+
+## [1.3.1] - 2022-08-14
+
+### Changed
+
+* Use the sparse-registry on nightly for faster access to the crate registry on nightly.
+    <https://internals.rust-lang.org/t/call-for-testing-cargo-sparse-registry/16862>
+
+## [1.3.0] - 2022-07-30
+
+### Added
+
+* An option to disable configuring Rust cache.
+    Thanks to @filips123 for the PR.
+
+## [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,17 +24,33 @@ 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 |
 | ------------ | --------------------------------------------------------------------------------- | ------- |
 | `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    |
 
 ## Outputs
 

action.yml

@@ -22,6 +22,10 @@ inputs:
   components:
     description: "Comma-separated list of components to be additionally installed"
     required: false
+  cache:
+    description: "Automatically configure Rust cache"
+    required: false
+    default: "true"
 
 outputs:
   rustc-version:
@@ -40,55 +44,103 @@ 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
-        echo "::set-output name=targets::$(for t in ${targets//,/ }; do echo -n ' --target' $t; done)"
-        echo "::set-output name=components::$(for c in ${components//,/ }; do echo -n ' --component' $c; done)"
-        echo "::set-output name=downgrade::${{inputs.toolchain == 'nightly' && inputs.components && ' --allow-downgrade' || ''}}"
+        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"
+      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 ]]; 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
+        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
+      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
           curl --proto '=https' --tlsv1.2 --retry 10 --retry-connrefused -fsSL "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y
-          echo "${CARGO_HOME:-~/.cargo}/bin" >> $GITHUB_PATH
+          echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
         fi
       if: runner.os != 'Windows'
       shell: bash
     - name: rustup toolchain install ${{inputs.toolchain}}
       run: |
-        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 [[ -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 "rustc-version=$(rustc --version)" >> $GITHUB_OUTPUT
+        rustc --version --verbose
+        echo "cargo-version=$(cargo --version)" >> $GITHUB_OUTPUT
+        cargo --version --verbose
+        echo "rustup-version=$(rustup --version)" >> $GITHUB_OUTPUT
+        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')
-        echo "::set-output name=cachekey::$(echo $DATE$HASH | head -c12)"
+        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
+
+    - 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
-    - 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

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
                 }
             ]
         }