From f2b7c181bee13989083653cd9c7c7836cdbc2fe4 Mon Sep 17 00:00:00 2001 From: IvanZosimov Date: Tue, 27 Sep 2022 15:14:41 +0200 Subject: [PATCH] Update documentation --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 0870974..aea9f83 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,41 @@ steps: ``` > **Note**: It's the only way to push a package to nuget.org feed for macOS/Linux machines due to API key config store limitations. +# Outputs and environment variables + +## Outputs + +### `dotnet-version` + +Using **dotnet-version** output it's possible to get the installed by action .NET SDK version. + +**Single version installation** + +In case of a single version installation, `dotnet-version` contains the version that is installed by the action. + +```yaml + - uses: actions/setup-dotnet@v3 + id: cp310 + with: + dotnet-version: 3.1.422 + - run: echo '${{ steps.cp310.outputs.dotnet-version }}' # outputs 3.1.422 +``` + +**Multiple version installation** + +In case of a multiple version installation, `dotnet-version` contains the latest version that is installed by the action. + +```yaml + - uses: actions/setup-dotnet@v3 + id: cp310 + with: + dotnet-version: | + 3.1.422 + 5.0.408 + - run: echo '${{ steps.cp310.outputs.dotnet-version }}' # outputs 5.0.408 +``` + + ## Environment variables Some environment variables may be necessary for your particular case or to improve logging. Some examples are listed below, but the full list with complete details can be found here: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-environment-variables