diff --git a/README.md b/README.md index 2343e60..d815b51 100644 --- a/README.md +++ b/README.md @@ -51,41 +51,97 @@ jobs: - + + - - - + + - - + + - - + + + - + -
NameDefault value DescriptionDefault value
toolchain + + rustup toolchain name. + It is recommended to use quotes in order to avoid versions being parsed as floating-point numbers. + + Example values: + - `stable` + - `nightly` + - `1.42.0` + - `nightly-2022-01-01` + + ([documentation][toolchain-doc]) + (required)rustup toolchain name e.g. stable, nightly, 1.42.0, nightly-2022-01-01—see the documentation. Consider putting the value between quotes to avoid it being parsed as a floating-point number.
targets''Comma-separated list of target triples to be additionally installed for this toolchain e.g. wasm32-unknown-unknown. + + Comma-separated list of target triples to be additionally installed for this toolchain. + + Example value: `wasm32-unknown-unknown` + + ([documentation][targets-doc]) + (empty)
components''Comma-separated list of components to be additionally installed for this toolchain e.g. clippy, rustfmt. + + Comma-separated list of components to be additionally installed for this toolchain. + + Example value: `clippy, rustfmt` + + ([documentation][components-doc]) + (empty)
profile'minimal'Group of components to install for this toolchain e.g. minimal, default, complete. Additional components can be installed with components. + + Group of components to install for this toolchain. + + Available values: + - `minimal` + - `default` + - `complete` + + ([documentation][profile-doc]) + minimal
default + + Set this toolchain as default. + Equivalent to running `rustup default` with this toolchain. + + ([documentation][default-doc]) + falseSet this toolchain as default. Equivalent to running rustup default ${{steps.toolchain.outputs.name}}.
override + + Set this toolchain as an override for this directory. + Equivalent to running `rustup override set` with this toolchain. + This is helpful if a `rustup-toolchain.toml` or `rustup-toolchain` file is present in the directory and you would like to use this toolchain instead. + + ([documentation][override-doc]) + falseSet this toolchain as an override for this directory. Equivalent to running rustup override set ${{steps.toolchain.outputs.name}}. This is helpful if a rustup-toolchain.toml or rustup-toolchain file is present in the directory and you would like to use this toolchain instead.
+[toolchain-doc]: https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification +[targets-doc]: https://doc.rust-lang.org/rustc/platform-support.html +[components-doc]: https://rust-lang.github.io/rustup/concepts/components.html +[profile-doc]: https://rust-lang.github.io/rustup/concepts/profiles.html +[default-doc]: https://rust-lang.github.io/rustup/overrides.html#default-toolchain +[override-doc]: https://rust-lang.github.io/rustup/overrides.html + ## Outputs @@ -95,11 +151,23 @@ jobs: - + - +
cachekeyA short hash of the installed rustc version e.g. 20220627a831. Appropriate for use as a cache key. + + A short hash of the installed rustc version. + Appropriate for use as a cache key. + + Example value: `20220627a831` +
namerustup's name for the selected version of the toolchain e.g. 1.62.0. Suitable for use with cargo +${{steps.toolchain.outputs.name}}. + + rustup's name for the selected version of the toolchain. + Suitable for use with the `cargo +toolchain` shorthand. + + Example value: `1.62.0` +