.NET GitHub actions guidelines

What the action does

The action gets the tag version, restores dependencies, and builds the project with a given configuration. Then the tests and code coverage tools are run. Eventually, the artifact is packaged and uploaded to the Nuget and GitHub Releases.

Notes

• Setting up of .NET environment is performed by actions/setup-dotnet@v3 action.
• Version tag is extracted using 3rd party battila7/get-version-action@v2 action.
• Dependencies are restored by run: dotnet restore command.
• Build is performed by dotnet build command provided with configuration info and extracted tag version.
• Tests are performed by dotnet test command with respective parameters.
• Nuget packages artifacts are uploaded using actions/upload-artifact@v3 action.
• Publishing of the Nuget Package is Performed by dotnet nuget push command with respective parameters and API keys.
• Package versions are set using $ - you can find more info in the documentation of the Action.
• Artifact is uploaded to GitHub Releases by Roang-zero1/github-upload-release-artifacts-action@v3.0.0 action.
• Tokens and secrets are stored in the Organization Secrets.

GitHub Action example

name: Publish to NuGet
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Setup .NET
      uses: actions/setup-dotnet@v3
      with:
        dotnet-version: 5.0.x
    - name: Extract version from tag
      id: get_version
      uses: battila7/get-version-action@v2
    - name: Restore dependencies
      run: dotnet restore
    - name: Build
      run: dotnet build --no-restore --configuration Release /p:ContinuousIntegrationBuild=true /p:Version="$"
    - name: Test
      run: dotnet test --no-build --verbosity normal --configuration Release /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
    - name: Codecov
      uses: codecov/codecov-action@v3
    - name: Pack
      run: dotnet pack --no-build --include-symbols --verbosity normal --configuration Release --output ./artifacts /p:PackageVersion="$"
    - name: Upload artifacts
      uses: actions/upload-artifact@v3
      with:
        name: "NuGet packages"
        path: ./artifacts
    - name: Publish artifacts to NuGet.org
      run: dotnet nuget push './artifacts/*.nupkg' -s https://api.nuget.org/v3/index.json -k ${NUGET_API_KEY} --skip-duplicate
      env:
        NUGET_API_KEY: $
    - name: Upload artifacts to the GitHub release
      uses: Roang-zero1/github-upload-release-artifacts-action@v3.0.0
      with:
        args: ./artifacts
      env:
        GITHUB_TOKEN: $

---

Table of contents

• Best practices for .csproj files
• Release