Switch the CI to GitHub Actions

[petrsvihlik]

Motivation

• Create a PoC of automatic building, testing, and deploying using GH Actions to verify the possibility of migrating from AppVeyor.

Acceptance Criteria

• The codebase is built and tested with every commit and PR (=> we know the status of the codebase)
• Failing tests will make the build fail and prevent any further steps (deployment)
• Artifacts are collected for every build Can be, it's easy but not necessary. We'll collect artifacts only for Releases.
• It's possible to create a "Release" from the master branch
  • The release will trigger a workflow that'll build the master branch and deploy the resulting NuGet package to NuGet.org
  • Symbol packages are also deployed (snupkg)
  • The NuGet package is correctly versioned (semver)
  • The version of the NuGet package can be defined as the tag version of the release
  • Allow pre-release suffixes
  • Upload artifacts to GH release, or this
  • Update release instructions in affected repos
  • Set status checks for protected branches
  • Exclude test projects from coverage

Optionally

• Define environments and require approval to proceed with deployment (when the build and tests pass ok) Gated builds work well.
• Try to replace Directory.Build.props with -p:NuspecProperties="Version=${{ steps.get_version.outputs.version-without-v }}
  • The combination of dotnet build -p:Version=1.2.3 and dotnet pack -p:PackageVersion=1.2.3 does the trick
• Try reporting without /p:CoverletOutputFormat=opencover doesn't work
• Deploy pre-releases to a different feed/unlisted? (eg. based on the event type prereleased) There is no switch in the NuGet CLI to publish a package as unlisted right now. It'd be an option to publish the package to MyGet for instance. Not going to explore this any further ATM.
• Add code coverage using coverlet collector + codecov + msdocs
• Create a reusable composite action Impossible due to Next Steps for Fully Functioning Composite Actions actions/runner#646 (there is a workaround though)

Proposed solution

Versioning

• Employ Directory.build.props for defining the version or version patching (AssemblyInfo, *.csprojs)

Examples from AppVeyor:
<Project><PropertyGroup><Version>$($ENV:APPVEYOR_BUILD_VERSION)</Version></PropertyGroup></Project>" | out-file "Directory.build.props (before build)
And:

dotnet_csproj:
  patch: true
  file: '**\*.csproj'
  version: '{version}'
  version_prefix: '{version}'
  package_version: '{version}'
  assembly_version: '{version}'
  file_version: '{version}'
  informational_version: '{version}'

Coverage

$buildConfig = if ($ENV:CONFIGURATION -eq $null) { "Release" } else { $ENV:CONFIGURATION }

$buildFolder = if ($ENV:APPVEYOR_BUILD_FOLDER -eq $null) { $PSScriptRoot } else { $ENV:APPVEYOR_BUILD_FOLDER }

$openCover = 'C:\ProgramData\chocolatey\lib\opencover.portable\tools\OpenCover.Console.exe'

$target = '-target:C:\Program Files\dotnet\dotnet.exe'
$targetArgs = '-targetargs:"test -c:' + $buildConfig + ' --logger:trx;LogFileName=results.trx --filter FullyQualifiedName!~Benchmarks /p:DebugType=full"' 
$filter = '-filter:+[Kentico.Kontent.Delivery*]*-[*Tests]*-[*Benchmarks]*'
$output = '-output:' + $buildFolder + '\coverage.xml'
$register = if ($ENV:APPVEYOR -eq $true ) { '-register' } else { '-register:user' } # Magical parameter that breaks things

& $openCover $target $targetArgs $filter $register '-oldStyle' '-mergeoutput' $output

Remaining repos

• kontent-sample-app-net (special: packing x86+x64 website for further internal CI steps)
• kontent-generators-net (special: packing standalone apps for multiple platforms)

Outstanding tasks

• fix globally: warning NU5048: The 'PackageIconUrl'/'iconUrl' element is deprecated. Consider using the 'PackageIcon'/'icon' element instead. Learn more at https://aka.ms/deprecateIconUrl

[petrsvihlik]

Findings:

Migration AppVeyor -> GitHub Actions (Win->Linux)

• Linux - case sensitivity (Directory.Build.props)
• some unit tests may be sensitive to the OS used (Win x Linux)
  • also, the syntax is a bit different
• pushing multiple packages
• Running PowerShell on Linux "shell: pwsh" There are two parameters: pwsh / powershell:
  • for “shell: pwsh”: powershell core(6.2.3) will be invoked.
  • for “shell: powershell”: desktop powershell(5.1) will be invoked.

Custom actions

• it's impossible to nest GH actions (see above)
• hosting multiple actions in a single repo IS possible...not sure if it's possible to publish them to the marketplace in this setup though

Symbols

• enable deterministic builds /p:ContinuousIntegrationBuild=true

Collecting coverage

• coverlet.msbuild is necessary for the following syntax dotnet test --no-build --verbosity normal --configuration Release /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
• coverage - add coverlet.msbuild

    <PackageReference Include="coverlet.collector" Version="3.0.3">
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
      <PrivateAssets>all</PrivateAssets>
    </PackageReference>
    <PackageReference Include="coverlet.msbuild" Version="3.0.3">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>

Protecting secrets when building forks

• it's necessary to use pull_request_target to build PRs from forks with actions that depend on secrets and here
  • there is, however, a problem with codecov described in Implement Passthrough of Bash Uploader Arguments codecov/codecov-action#156
    • workaround no. 1 for codecov: https://github.com/Cookie-AutoDelete/Cookie-AutoDelete/blob/3.X.X-Branch/.github/codecov_alt.sh + action
    • workaround no. 2 for codecov: Action fails to upload when using pull_request_target on GitHub codecov/codecov-action#155 (comment)
    • my workaround: Action fails to upload when using pull_request_target on GitHub codecov/codecov-action#155 (comment)

[petrsvihlik]

articles to be published at https://dev.to/petrsvihlik