Use .NET Core SDK 3.1 (#178)

* Use .NET Core SDK 3.1, closes #177
* ci: install netcoreapp2.1 runtime
* feature: Add back net20, net40 TFM to Attributes
* build: Drop MSBuild.Sdk.Extras reference since it's no longer used
* ci: Non-windows builds all use dotnet on AzP/Win, closes #153
* build: Reference Microsoft.NETFramework.ReferenceAssemblies package
* docs: Update README, add CHANGELOG and CONTRIBUTING
* build: Use ngbv v3.0.28
* feature: Use Roslyn v3.4.0 nuget
* ci: Add binlog to gh actions
* build: Fix the casing error that impacted only Ubuntu
* build: Treat warnings as errors
* docs: Add GH Actions badge to readme

Author: amis92

.github/workflows/ci.yml

@@ -12,18 +12,28 @@ on:
 
 env:
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
-  dotnet_sdk_version: '2.1.500'
   build_configuration: Release
 
 jobs:
   build-windows:
     runs-on: windows-latest
     steps:
     - uses: actions/checkout@v1
+    - name: Install .NET Core
+      shell: pwsh
+      run: |
+        $info = dotnet --info
+        $isRuntime = $info -contains 'Microsoft.NETCore.App 2.1'
+        Push-Location src; dotnet --version > $null; Pop-Location; $isSdk = $LASTEXITCODE -eq 0; $LASTEXITCODE = 0
+        if ($isSdk -and $isRuntime) { return }
+        [string]$dotnetroot = "~/.dotnet" | %{ if (-not (Test-Path $_)) { mkdir $_ > $null }; Resolve-Path $_ } 
+        Invoke-WebRequest "https://dotnetwebsite.azurewebsites.net/download/dotnet-core/scripts/v1/dotnet-install.ps1" -OutFile ~/dotnet-install.ps1
+        ~/dotnet-install.ps1 -JsonFile src/global.json -InstallDir $dotnetroot
+        ~/dotnet-install.ps1 -Channel 2.1 -Runtime dotnet -InstallDir $dotnetroot
+        Write-Output "::add-path::$dotnetroot"
+        Write-Output "::set-env name=DOTNET_ROOT::$dotnetroot"
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: ${{ env.dotnet_sdk_version }}
     - run: dotnet --info
     - name: Install and run nbgv
       run: |
@@ -32,7 +42,7 @@ jobs:
     - name: Restore
       run: dotnet restore src -v normal
     - name: Build
-      run: dotnet build src -t:build,pack --no-restore -m -c ${{ env.build_configuration }}
+      run: dotnet build src -t:build,pack --no-restore -m -c ${{ env.build_configuration }} -bl:obj/logs/build-windows.binlog
     - name: Test
       run: dotnet test src --no-build -c ${{ env.build_configuration }}
     - name: Upload nugets
@@ -41,28 +51,48 @@ jobs:
       with:
         name: nugets
         path: bin/Packages/${{ env.build_configuration }}
+    - name: Upload logs
+      uses: actions/upload-artifact@v1
+      with:
+        name: logs-windows
+        path: obj/logs/
 
   build-other:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-    env:
-      project_path: 'src/CodeGeneration.Roslyn.Tests'
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v1
+    - name: Install .NET Core
+      shell: pwsh
+      run: |
+        $info = dotnet --info
+        $isRuntime = $info -contains 'Microsoft.NETCore.App 2.1'
+        Push-Location src; dotnet --version > $null; Pop-Location; $isSdk = $LASTEXITCODE -eq 0; $LASTEXITCODE = 0
+        if ($isSdk -and $isRuntime) { return }
+        [string]$dotnetroot = "~/.dotnet" | %{ if (-not (Test-Path $_)) { mkdir $_ > $null }; Resolve-Path $_ } 
+        Invoke-WebRequest "https://dotnetwebsite.azurewebsites.net/download/dotnet-core/scripts/v1/dotnet-install.sh" -OutFile ~/dotnet-install.sh
+        chmod +x ~/dotnet-install.sh
+        ~/dotnet-install.sh -JsonFile src/global.json -InstallDir $dotnetroot
+        ~/dotnet-install.sh -Channel 2.1 -Runtime dotnet -InstallDir $dotnetroot
+        Write-Output "::add-path::$dotnetroot"
+        Write-Output "::set-env name=DOTNET_ROOT::$dotnetroot"
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: ${{ env.dotnet_sdk_version }}
     - run: dotnet --info
     - name: Install and run nbgv
       run: |
-        dotnet tool install --tool-path . nbgv
+        dotnet tool install --tool-path . nbgv --version 3.0.28
         ./nbgv get-version -p src
     - name: Restore
-      run: dotnet restore ${{ env.project_path }} -v normal
+      run: dotnet restore src -v normal
     - name: Build
-      run: dotnet build ${{ env.project_path }} --no-restore -m -c ${{ env.build_configuration }} -f netcoreapp2.1
+      run: dotnet build src --no-restore -m -c ${{ env.build_configuration }}  -bl:obj/logs/build-${{ matrix.os }}.binlog
     - name: Test
-      run: dotnet test ${{ env.project_path }} --no-build -c ${{ env.build_configuration }} -f netcoreapp2.1
+      run: dotnet test src --no-build -c ${{ env.build_configuration }} -f netcoreapp2.1
+    - name: Upload logs
+      uses: actions/upload-artifact@v1
+      with:
+        name: logs-${{ matrix.os }}
+        path: obj/logs/

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+* GeneratorInCustomerSolution sample in `samples` folder
+* GitHub Actions CI
+
+### Changed
+* .NET Core SDK version bumped to `3.1.100` ([#178]).
+* `Attributes` package now targets `net20;net40` in addition to `netstandard1.0` ([#178]).
+
+[#178]: https://github.com/AArnott/CodeGeneration.Roslyn/pull/178
+
+
+## [0.6.1] - 2019-06-16
+
+See https://github.com/AArnott/CodeGeneration.Roslyn/releases/tag/v0.6.1
+
+[Unreleased]: https://github.com/amis92/RecordGenerator/compare/v0.6.1...HEAD
+[0.6.1]: #061---2019-06-16

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+## Prerequisites
+
+* .NET Core SDK - version as specified in [src/global.json](src/global.json).
+* netcoreapp2.1 runtime (Microsoft.NETCore.App 2.1.x)
+
+## Building
+
+* Using shell/command line: `dotnet build src`
+* Using Visual Studio: min. VS2019 v16.4., open [src/CodeGeneration.Roslyn.sln](src/CodeGeneration.Roslyn.sln)

README.md

@@ -1,6 +1,7 @@
 # Roslyn-based Code Generation
 
 [![Build Status](https://andrewarnott.visualstudio.com/OSS/_apis/build/status/CodeGeneration.Roslyn)](https://andrewarnott.visualstudio.com/OSS/_build/latest?definitionId=15)
+[![GitHub Actions CI status](https://github.com/AArnott/CodeGeneration.Roslyn/workflows/CI/badge.svg?branch=master)](https://github.com/AArnott/CodeGeneration.Roslyn/actions?query=workflow%3ACI+branch%3Amaster)
 [![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.svg)][NuPkg]
 
 Assists in performing Roslyn-based code generation during a build.
@@ -10,6 +11,8 @@ up to Intellisense as soon as the file is saved to disk.
 
 See [who's generating code or consuming it using CodeGeneration.Roslyn](https://github.com/AArnott/CodeGeneration.Roslyn/wiki/Users).
 
+Instructions on development and using this project's source code are in [CONTRIBUTING.md](CONTRIBUTING.md).
+
 ## Table of Contents
 
 * [How to write your own code generator][]
@@ -30,8 +33,6 @@ your code generation attribute is applied to, but with a suffix appended to its
   If you don't have v2.1+ there will be cryptic error messages
   (see [#111](https://github.com/AArnott/CodeGeneration.Roslyn/issues/111)).
 
-* .NET Core SDK v2.1.500 specifically for building this project
-
 [dotnet-sdk-2.1]: https://dotnet.microsoft.com/download/dotnet-core/2.1
 
 ### Define code generator

azure-pipeline.yml

@@ -17,15 +17,23 @@ resources:
 
 jobs:
 - job: Windows
-  pool: Hosted VS2017
+  pool:
+    vmImage: 'windows-2019'
   steps:
-  - task: DotNetCoreInstaller@0
+  - task: UseDotNet@2
+    displayName: Install .NET Core runtime v2.1
+    inputs:
+      packageType: runtime
+      version: '2.1.x'
+
+  - task: UseDotNet@2
     displayName: Install/select .NET Core SDK
     inputs:
-      version: '2.1.500'
+      useGlobalJson: true
+      workingDirectory: src
 
   - script: |
-      dotnet tool install --tool-path . nbgv
+      dotnet tool install --tool-path . nbgv --version 3.0.28
       .\nbgv cloud -p src
     displayName: Set build number
     condition: ne(variables['system.pullrequest.isfork'], true)
@@ -36,22 +44,17 @@ jobs:
   - task: DotNetCoreCLI@2
     displayName: Restore NuGet packages
     inputs:
-      command: restore
-      verbosityRestore: normal # detailed, normal, minimal
+      command: custom
+      custom: restore
       projects: src/**/*.sln
-      feedsToUse: config
-      nugetConfigPath: src/nuget.config
 
-  # Use VSBuild on Windows so GitLink will work (it fails on dotnet build)
-  # Also targeting net20, net40, PCLs etc requires full MSBuild
-  - task: VSBuild@1
-    displayName: Build Visual Studio solution
+  - task: DotNetCoreCLI@2
+    displayName: Build solutions
     inputs:
-      vsVersion: '15.0'
-      solution: src/**/*.sln
-      msbuildArgs: /t:build,pack /m /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog"
-      platform: $(BuildPlatform)
-      configuration: $(BuildConfiguration)
+      command: custom
+      custom: build
+      projects: src/**/*.sln
+      arguments: -t:build,pack --no-restore -m -c $(BuildConfiguration) -bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog"
 
   - task: DotNetCoreCLI@2
     displayName: Run tests

azure-pipelines/testfx.yml

@@ -1,8 +1,18 @@
 steps:
+- task: UseDotNet@2
+  displayName: Install .NET Core runtime v2.1
+  inputs:
+    packageType: runtime
+    version: '2.1.x'
+- task: UseDotNet@2
+  displayName: Install/select .NET Core SDK
+  inputs:
+    useGlobalJson: true
+    workingDirectory: src
 - script: dotnet restore
   displayName: Restore packages
   workingDirectory: ${{ parameters.projectdirectory }}
-- script: dotnet build -v n -f netcoreapp2.1 -c $(BuildConfiguration) --no-restore /bl:"$(Build.ArtifactStagingDirectory)/build_logs/netcoreapp2.1.binlog" -p:GitLinkEnabled=false
+- script: dotnet build -v n -c $(BuildConfiguration) --no-restore /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog"
   displayName: Build tests for netcoreapp2.1
   workingDirectory: ${{ parameters.projectdirectory }}
 - script: dotnet test -v n -f netcoreapp2.1 -c $(BuildConfiguration) --no-build

src/CodeGeneration.Roslyn.Attributes/CodeGeneration.Roslyn.Attributes.csproj

@@ -1,7 +1,7 @@
-<Project Sdk="MSBuild.Sdk.Extras">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard1.0</TargetFrameworks>
+    <TargetFrameworks>net20;net40;netstandard1.0</TargetFrameworks>
     <RootNamespace>CodeGeneration.Roslyn</RootNamespace>
     <Description>A package that offers attributes to drive code generation.</Description>
   </PropertyGroup>

src/CodeGeneration.Roslyn.Tests.ruleset

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <RuleSet Name="Tests Rules" Description="Additional rules (exceptions) for test projects." ToolsVersion="15.0">
-  <Include Path="codegeneration.roslyn.ruleset" Action="Default" />
+  <Include Path="CodeGeneration.Roslyn.ruleset" Action="Default" />
   <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
     <Rule Id="SA0001" Action="Hidden" />
     <Rule Id="SA1402" Action="Hidden" />

src/CodeGeneration.Roslyn.Tool/CodeGeneration.Roslyn.Tool.csproj

@@ -8,6 +8,7 @@
     <Description>The dotnet code generation tool that works with the CodeGeneration.Roslyn nuget package.</Description>
     <CodeAnalysisRuleSet>CodeGeneration.Roslyn.Tool.ruleset</CodeAnalysisRuleSet>
     <NoWarn>$(NoWarn);CS1591</NoWarn>
+    <RollForward>Major</RollForward>
   </PropertyGroup>
 
   <ItemGroup>

src/CodeGeneration.Roslyn.Tool/CodeGeneration.Roslyn.Tool.ruleset

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <RuleSet Name="Tests Rules" Description="Additional rules (exceptions) for test projects." ToolsVersion="15.0">
-  <Include Path="../codegeneration.roslyn.tests.ruleset" Action="Default" />
+  <Include Path="../CodeGeneration.Roslyn.Tests.ruleset" Action="Default" />
   <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
     <!--for the CommandLine files-->
     <Rule Id="SA1028" Action="Hidden" />