actions
/
setup-dotnet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #359 from akv-platform/documentation-clarification 

Update README.md to clarify installation process
This commit is contained in:
Ivan 2022-12-21 16:17:31 +02:00 committed by GitHub
parent 09d024bd02 13abe4777e
commit e1d35446fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -10,8 +10,8 @@ This action sets up a [.NET CLI](https://github.com/dotnet/sdk) environment for
> **Note**: GitHub hosted runners have some versions of the .NET SDK > **Note**: GitHub hosted runners have some versions of the .NET SDK
preinstalled. Installed versions are subject to change. Please refer to the preinstalled. Installed versions are subject to change. Please refer to the
documentation documentation:
[software installed on github hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software) [Software installed on github hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)
for .NET SDK versions that are currently available. for .NET SDK versions that are currently available.
## Usage ## Usage
@ -27,6 +27,7 @@ steps:
dotnet-version: '3.1.x' dotnet-version: '3.1.x'
- run: dotnet build <my project> - run: dotnet build <my project>
``` ```
> **Warning**: Unless a concrete version is specified in the [`global.json`](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) file, **_the latest .NET version installed on the runner (including preinstalled versions) will be used [by default](https://learn.microsoft.com/en-us/dotnet/core/versions/selection#the-sdk-uses-the-latest-installed-version)_**. Please refer to the [documentation](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software) for the currently preinstalled .NET SDK versions.
**Multiple version installation**: **Multiple version installation**:
```yml ```yml
@ -40,8 +41,6 @@ steps:
5.0.x 5.0.x
- run: dotnet build <my project> - run: dotnet build <my project>
``` ```
> **Note**: In case multiple versions are installed, the latest .NET version will be used by default unless another version is specified in the `global.json` file.
## Supported version syntax ## Supported version syntax
The `dotnet-version` input supports following syntax: The `dotnet-version` input supports following syntax:
@ -97,7 +96,31 @@ jobs:
uses: actions/setup-dotnet@v3 uses: actions/setup-dotnet@v3
with: with:
dotnet-version: ${{ matrix.dotnet }} dotnet-version: ${{ matrix.dotnet }}
- run: dotnet build <my project> - name: Execute dotnet
run: dotnet build <my project>
```
>**Note**: Unless a concrete version is specified in the [`global.json`](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) file, the latest .NET version installed on the runner (including preinstalled versions) will be used [by default](https://learn.microsoft.com/en-us/dotnet/core/versions/selection#the-sdk-uses-the-latest-installed-version). To control this behavior you may want to use temporary `global.json` files:
**Matrix testing with temporary global.json creation**
```yml
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
dotnet: [ '2.1.x', '3.1.x', '5.0.x' ]
name: Dotnet ${{ matrix.dotnet }} sample
steps:
- uses: actions/checkout@v3
- name: Setup dotnet
uses: actions/setup-dotnet@v3
id: stepid
with:
dotnet-version: ${{ matrix.dotnet }}
- name: Create temporary global.json
run: echo '{"sdk":{"version": "${{ steps.stepid.outputs.dotnet-version }}"}}' > ./global.json
- name: Execute dotnet
run: dotnet build <my project>
``` ```
## Setting up authentication for nuget feeds ## Setting up authentication for nuget feeds
@ -155,10 +178,10 @@ In case of a single version installation, the `dotnet-version` output contains t
```yaml ```yaml
- uses: actions/setup-dotnet@v3 - uses: actions/setup-dotnet@v3
id: cp310 id: stepid
with: with:
dotnet-version: 3.1.422 dotnet-version: 3.1.422
- run: echo '${{ steps.cp310.outputs.dotnet-version }}' # outputs 3.1.422 - run: echo '${{ steps.stepid.outputs.dotnet-version }}' # outputs 3.1.422
``` ```
**Multiple version installation** **Multiple version installation**
@ -167,12 +190,12 @@ In case of a multiple version installation, the `dotnet-version` output contains
```yaml ```yaml
- uses: actions/setup-dotnet@v3 - uses: actions/setup-dotnet@v3
id: cp310 id: stepid
with: with:
dotnet-version: | dotnet-version: |
3.1.422 3.1.422
5.0.408 5.0.408
- run: echo '${{ steps.cp310.outputs.dotnet-version }}' # outputs 5.0.408 - run: echo '${{ steps.stepid.outputs.dotnet-version }}' # outputs 5.0.408
``` ```
**Installation from global.json** **Installation from global.json**
@ -180,13 +203,13 @@ When the `dotnet-version` input is used along with the `global-json-file` input,
```yaml ```yaml
- uses: actions/setup-dotnet@v3 - uses: actions/setup-dotnet@v3
id: cp310 id: stepid
with: with:
dotnet-version: | dotnet-version: |
3.1.422 3.1.422
5.0.408 5.0.408
global-json-file: "./global.json" # contains version 2.2.207 global-json-file: "./global.json" # contains version 2.2.207
- run: echo '${{ steps.cp310.outputs.dotnet-version }}' # outputs 2.2.207 - run: echo '${{ steps.stepid.outputs.dotnet-version }}' # outputs 2.2.207
``` ```
## Environment variables ## Environment variables