From 3fd7e41f91cfcd0899351e33e536195ac5fd3c4f Mon Sep 17 00:00:00 2001 From: David Tolnay <dtolnay@gmail.com> Date: Wed, 1 Feb 2023 15:04:54 -0800 Subject: [PATCH] Document workflow outputs in a table in readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 6ec4744..86f4262 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,25 @@ All inputs are optional. <br> +## Outputs + +<table> +<tr> + <th>Name</th> + <th>Description</th> +</tr> +<tr> + <td><code>cachekey</code></td> + <td>A short hash of the installed rustc version, appropriate for use as a cache key. <code>"20220627a831"</code></td> +</tr> +<tr> + <td><code>name</code></td> + <td>Rustup's name for the selected version of the toolchain, like <code>"1.62.0"</code>. Suitable for use with <code>cargo +${{steps.toolchain.outputs.name}}</code>.</td> +</tr> +</table> + +<br> + ## Toolchain expressions The following forms are available for projects that use a sliding window of