Go to file
Michael Glenn ba45b6ef7e
Create setup-dotnet-core-cli
2021-06-26 17:06:40 -05:00
.github Use permissions as a top-level key 2021-05-27 16:20:43 +03:00
.licenses/npm Update `@actions/core` Version and move towards uses environment files to talk to runner (#135) 2020-09-29 08:12:29 -07:00
__tests__ fix test 2021-03-18 11:07:32 +03:00
dist Merge pull request #110 from GGG-KILLER/feature/include-prerelease 2021-05-05 15:53:38 +03:00
docs Update contributors.md 2020-10-08 10:51:05 -07:00
externals Update Linux installer 2021-02-11 10:32:14 +03:00
src Merge pull request #110 from GGG-KILLER/feature/include-prerelease 2021-05-05 15:53:38 +03:00
.gitattributes Ignore Generated Files in Git PR's 2020-08-26 11:21:21 -04:00
.gitignore Install sxs with the install-dotnet scripts (#124) 2020-09-15 09:36:09 -07:00
.licensed.yml Setup Licensed workflow and config files 2020-08-11 20:48:13 -04:00
.prettierrc.json Initial commit 2019-06-19 16:22:22 -04:00
LICENSE Initial commit 2019-06-19 16:22:22 -04:00
README.md Update README.md 2021-05-06 21:38:47 +07:00
action.yml Include include-prerelease input in action.yml 2021-02-19 13:29:15 -03:00
jest.config.js Initial commit 2019-06-19 16:22:22 -04:00
package-lock.json Bump y18n from 4.0.0 to 4.0.1 2021-03-30 22:18:10 +00:00
package.json Update `@actions/core` Version and move towards uses environment files to talk to runner (#135) 2020-09-29 08:12:29 -07:00
setup-dotnet-core-cli Create setup-dotnet-core-cli 2021-06-26 17:06:40 -05:00
tsconfig.json GPR authentication support 2019-10-03 16:35:25 -07:00

README.md

setup-dotnet

GitHub Actions status

This action sets up a dotnet core cli environment for use in actions by:

  • optionally downloading and caching a version of dotnet by SDK version and adding to PATH
  • registering problem matchers for error output
  • setting up authentication to private package sources like GitHub Packages

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 for .NET SDK versions that are currently available.

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-dotnet@v1
  with:
    dotnet-version: '3.1.x' # SDK Version to use; x will use the latest version of the 3.1 channel
- run: dotnet build <my project>

Preview version:

steps:
- uses: actions@checkout@v2
- uses: actions/setup-dotnet@v1
  with:
    dotnet-version: '6.0.x'
    include-prerelease: true
- run: dotnet build <my project>

Matrix Testing:

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@v2
      - name: Setup dotnet
        uses: actions/setup-dotnet@v1
        with:
          dotnet-version: ${{ matrix.dotnet }}
      - run: dotnet build <my project>

Side by Side Testing:

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.1.x'
      - name: Setup dotnet
        uses: actions/setup-dotnet@v1
        with:
          dotnet-version: '3.1.x'
      - run: dotnet build <my project>
      - run: dotnet test <my project>

Authentication for nuget feeds:

steps:
- uses: actions/checkout@v2
# Authenticates packages to push to GPR
- uses: actions/setup-dotnet@v1
  with:
    dotnet-version: '3.1.x' # SDK Version to use.
    source-url: https://nuget.pkg.github.com/<owner>/index.json
  env:
    NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
- run: dotnet build <my project>
- name: Create the package
  run: dotnet pack --configuration Release <my project>
- name: Publish the package to GPR
  run: dotnet nuget push <my project>/bin/Release/*.nupkg

# Authenticates packages to push to Azure Artifacts
- 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
- name: Publish the package to Azure Artifacts
  run: dotnet nuget push <my project>/bin/Release/*.nupkg

# Authenticates packages to push to nuget.org.
# It's only the way to push a package to nuget.org feed for macOS/Linux machines due to API key config store limitations.
- uses: actions/setup-dotnet@v1
  with:
    dotnet-version: 3.1.x
- name: Publish the package to nuget.org
  run: dotnet nuget push */bin/Release/*.nupkg -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json
  env:
    NUGET_AUTH_TOKEN: ${{ secrets.NUGET_TOKEN }}

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:

build:
  runs-on: ubuntu-latest
  env:
    DOTNET_NOLOGO: true
  steps:
    - uses: actions/checkout@main
    - uses: actions/setup-dotnet@v1
      with:
        dotnet-version: '3.1.x' # SDK Version to use.

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome! See Contributor's Guide