setup-dotnet/README.md

126 lines
3.9 KiB
Markdown
Raw Permalink Normal View History

2019-07-17 21:45:43 +07:00
# setup-dotnet
2019-06-20 03:22:22 +07:00
2019-08-13 02:11:11 +07:00
<p align="left">
<a href="https://github.com/actions/setup-dotnet"><img alt="GitHub Actions status" src="https://github.com/actions/setup-dotnet/workflows/Main%20workflow/badge.svg"></a>
</p>
This action sets up a [dotnet core cli](https://github.com/dotnet/cli) environment for use in actions by:
2019-06-20 03:22:22 +07:00
2019-08-02 03:40:13 +07:00
- optionally downloading and caching a version of dotnet by SDK version and adding to PATH
2019-07-17 21:45:43 +07:00
- registering problem matchers for error output
- setting up authentication to private package sources like GitHub Packages
2019-07-17 21:45:43 +07:00
Please Note: GitHub hosted runners have some versions of the .NET SDK
preinstalled. Installed versions are subject to change. Please refer to the
documentation
[software installed on github hosted runners](https://help.github.com/en/actions/reference/software-installed-on-github-hosted-runners)
for .NET SDK versions that are currently available.
2019-07-17 21:45:43 +07:00
# Usage
See [action.yml](action.yml)
Basic:
```yaml
2019-07-26 08:27:45 +07:00
steps:
2020-07-16 00:00:26 +07:00
- uses: actions/checkout@main
- uses: actions/setup-dotnet@v1
2019-07-17 21:45:43 +07:00
with:
2020-04-05 00:47:16 +07:00
dotnet-version: '3.1.x' # SDK Version to use; x will use the latest version of the 3.1 channel
2019-07-17 21:45:43 +07:00
- run: dotnet build <my project>
```
Matrix Testing:
```yaml
jobs:
build:
2020-09-18 02:49:59 +07:00
runs-on: ubuntu-latest
2019-07-17 21:45:43 +07:00
strategy:
matrix:
2020-04-10 00:29:16 +07:00
dotnet: [ '2.2.103', '3.0', '3.1.x' ]
2019-07-17 21:45:43 +07:00
name: Dotnet ${{ matrix.dotnet }} sample
2019-07-26 08:27:45 +07:00
steps:
- uses: actions/checkout@v2
2019-07-17 21:45:43 +07:00
- name: Setup dotnet
uses: actions/setup-dotnet@v1
2019-07-17 21:45:43 +07:00
with:
2019-08-14 03:05:52 +07:00
dotnet-version: ${{ matrix.dotnet }}
2019-07-17 21:45:43 +07:00
- run: dotnet build <my project>
```
2019-06-20 03:22:22 +07:00
2020-09-18 02:49:59 +07:00
Side by Side Testing:
```yaml
jobs:
build:
runs-on: ubuntu-latest
name: Dotnet Side by Side testing sample
steps:
- uses: actions/checkout@v2
- name: Setup dotnet
uses: actions/setup-dotnet@v1
with:
dotnet-version: '2.2.103'
- name: Setup dotnet
uses: actions/setup-dotnet@v1
with:
dotnet-version: '3.1.x'
- run: dotnet build <my project>
- run: dotnet test <my project>
```
2019-11-26 06:16:52 +07:00
Authentication for nuget feeds:
2019-09-10 00:27:23 +07:00
```yaml
steps:
- uses: actions/checkout@v2
2019-11-26 06:16:52 +07:00
# Authenticates packages to push to GPR
2019-09-10 00:27:23 +07:00
- uses: actions/setup-dotnet@v1
with:
2020-04-05 00:47:16 +07:00
dotnet-version: '3.1.x' # SDK Version to use.
2019-11-26 06:16:52 +07:00
source-url: https://nuget.pkg.github.com/<owner>/index.json
2019-09-10 00:27:23 +07:00
env:
NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
- run: dotnet build <my project>
- name: Create the package
run: dotnet pack --configuration Release <my project>
2019-11-26 06:16:52 +07:00
- name: Publish the package to GPR
2019-09-10 00:27:23 +07:00
run: dotnet nuget push <my project>/bin/Release/*.nupkg
2019-11-26 06:16:52 +07:00
# Authticates packages to push to Azure Artifacts
2019-10-04 08:00:43 +07:00
- uses: actions/setup-dotnet@v1
with:
source-url: https://pkgs.dev.azure.com/<your-organization>/_packaging/<your-feed-name>/nuget/v3/index.json
env:
NUGET_AUTH_TOKEN: ${{secrets.AZURE_DEVOPS_PAT}} # Note, create a secret with this name in Settings
2019-11-26 06:16:52 +07:00
- name: Publish the package to Azure Artifacts
2019-10-04 08:00:43 +07:00
run: dotnet nuget push <my project>/bin/Release/*.nupkg
```
## Environment Variables to use with dotnet
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
- DOTNET_NOLOGO - removes logo and telemetry message from first run of dotnet cli (default: false)
- DOTNET_CLI_TELEMETRY_OPTOUT - opt-out of telemetry being sent to Microsoft (default: false)
- DOTNET_MULTILEVEL_LOOKUP - configures whether the global install location is used as a fall-back (default: true)
Example usage:
```yaml
2020-06-01 22:53:23 +07:00
build:
runs-on: ubuntu-latest
env:
DOTNET_NOLOGO: true
2020-06-01 22:53:23 +07:00
steps:
2020-07-16 00:00:26 +07:00
- uses: actions/checkout@main
2020-06-01 22:53:23 +07:00
- uses: actions/setup-dotnet@v1
with:
dotnet-version: '3.1.100' # SDK Version to use.
```
2019-06-20 03:22:22 +07:00
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
# Contributions
Contributions are welcome! See [Contributor's Guide](docs/contributors.md)