mirror of
https://github.com/actions-rust-lang/setup-rust-toolchain.git
synced 2025-12-27 01:54:20 -05:00
Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
11df97af8e | ||
|
|
4d1965c914 | ||
|
|
b31b1317f2 | ||
|
|
9f99923fad | ||
|
|
86a2ce6673 | ||
|
|
eb4a655afd | ||
|
|
a90048dfdd | ||
|
|
597574aacb | ||
|
|
634cedf365 | ||
|
|
5d6934e965 | ||
|
|
b01657d9bb | ||
|
|
1fbea72663 | ||
|
|
46dca5d120 | ||
|
|
1734e14b0b | ||
|
|
74e1b40e68 | ||
|
|
d60b90debe |
18
.pre-commit-config.yaml
Normal file
18
.pre-commit-config.yaml
Normal file
@@ -0,0 +1,18 @@
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.6.0
|
||||
hooks:
|
||||
- id: check-case-conflict
|
||||
- id: check-executables-have-shebangs
|
||||
- id: check-merge-conflict
|
||||
- id: check-json
|
||||
- id: check-yaml
|
||||
- id: end-of-file-fixer
|
||||
- id: trailing-whitespace
|
||||
args: [--markdown-linebreak-ext=md]
|
||||
- repo: https://github.com/python-jsonschema/check-jsonschema
|
||||
rev: 0.29.2
|
||||
hooks:
|
||||
- id: check-dependabot
|
||||
- id: check-github-actions
|
||||
- id: check-github-workflows
|
||||
21
CHANGELOG.md
21
CHANGELOG.md
@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [1.10.1] - 2024-10-01
|
||||
|
||||
* Fix problem matcher for rustfmt output.
|
||||
The format has changed since https://github.com/rust-lang/rustfmt/pull/5971 and now follows the form "filename:line".
|
||||
Thanks to @0xcypher02 for pointing out the problem.
|
||||
|
||||
## [1.10.0] - 2024-09-23
|
||||
|
||||
* Add new parameter `cache-directories` that is propagated to `Swatinem/rust-cache` (#44 by @pranc1ngpegasus)
|
||||
* Add new parameter `cache-key` that is propagated to `Swatinem/rust-cache` as `key` (#41 by @iainlane)
|
||||
* Make rustup toolchain installation more robust in light of planned changes https://github.com/rust-lang/rustup/issues/3635 and https://github.com/rust-lang/rustup/pull/3985
|
||||
* Allow installing multiple Rust toolchains by specifying multiple versions in the `toolchain` input parameter.
|
||||
* Configure the `rustup override` behavior via the new `override` input. (#38)
|
||||
|
||||
## [1.9.0] - 2024-06-08
|
||||
|
||||
* Add extra argument `cache-on-failure` and forward it to `Swatinem/rust-cache`. (#39 by @samuelhnrq)
|
||||
Set the default the value to true.
|
||||
This will result in more caching than previously.
|
||||
This helps when large dependencies are compiled only for testing to fail.
|
||||
|
||||
## [1.8.0] - 2024-01-13
|
||||
|
||||
* Allow specifying subdirectories for cache.
|
||||
|
||||
24
README.md
24
README.md
@@ -48,15 +48,21 @@ 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 |
|
||||
| `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" |
|
||||
| Name | Description | Default |
|
||||
| ------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------- |
|
||||
| `toolchain` | Comma-separated list of Rustup toolchain specifier e.g. `stable`, `nightly`, `1.42.0`. The last version is the default. | 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-directories` | Propagates the value to [`Swatinem/rust-cache`] | |
|
||||
| `cache-workspaces` | Propagates the value to [`Swatinem/rust-cache`] | |
|
||||
| `cache-on-failure` | Propagates the value to [`Swatinem/rust-cache`] | true |
|
||||
| `cache-key` | Propagates the value to [`Swatinem/rust-cache`] as `key` | |
|
||||
| `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" |
|
||||
| `override` | Setup the last installed toolchain as the default via `rustup override` | true |
|
||||
|
||||
[`Swatinem/rust-cache`]: https://github.com/Swatinem/rust-cache
|
||||
|
||||
### RUSTFLAGS
|
||||
|
||||
|
||||
36
action.yml
36
action.yml
@@ -13,7 +13,7 @@ branding:
|
||||
# The action is heavily inspired by https://github.com/dtolnay/rust-toolchain
|
||||
inputs:
|
||||
toolchain:
|
||||
description: "Rust toolchain specification -- see https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification"
|
||||
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"
|
||||
@@ -28,6 +28,16 @@ inputs:
|
||||
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: "Also cache on workflow failures"
|
||||
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
|
||||
matcher:
|
||||
description: "Enable the Rust problem matcher"
|
||||
required: false
|
||||
@@ -36,6 +46,10 @@ inputs:
|
||||
description: "set RUSTFLAGS environment variable, set to empty string to avoid overwriting build.rustflags"
|
||||
required: false
|
||||
default: "-D warnings"
|
||||
override:
|
||||
description: "Setup the last installed toolchain as the default via `rustup override`"
|
||||
required: false
|
||||
default: "true"
|
||||
|
||||
outputs:
|
||||
rustc-version:
|
||||
@@ -70,7 +84,7 @@ runs:
|
||||
: 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
|
||||
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
|
||||
@@ -122,13 +136,16 @@ runs:
|
||||
toolchain: ${{inputs.toolchain}}
|
||||
targets: ${{inputs.target}}
|
||||
components: ${{inputs.components}}
|
||||
override: ${{inputs.override}}
|
||||
shell: bash
|
||||
run: |
|
||||
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
|
||||
# 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 $components ]]; then
|
||||
rustup component add ${components//,/ }
|
||||
fi
|
||||
@@ -140,8 +157,12 @@ runs:
|
||||
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
|
||||
rustup toolchain install ${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 [[ "$override" == "true" ]]
|
||||
then
|
||||
rustup override set ${toolchain//*,/ }
|
||||
fi
|
||||
fi
|
||||
|
||||
- id: versions
|
||||
@@ -176,3 +197,6 @@ runs:
|
||||
uses: Swatinem/rust-cache@v2
|
||||
with:
|
||||
workspaces: ${{inputs.cache-workspaces}}
|
||||
cache-directories: ${{inputs.cache-directories}}
|
||||
cache-on-failure: ${{inputs.cache-on-failure}}
|
||||
key: ${{inputs.cache-key}}
|
||||
|
||||
Reference in New Issue
Block a user