upgrade to .net 6, move to project-based build pipeline

Author: kMutagene

Diff for: .config/dotnet-tools.json

@@ -2,29 +2,17 @@
   "version": 1,
   "isRoot": true,
   "tools": {
-    "fake-cli": {
-      "version": "5.20.4",
-      "commands": [
-        "fake"
-      ]
-    },
-    "paket": {
-      "version": "5.257.0",
+    "fantomas-tool": {
+      "version": "4.7.5",
       "commands": [
-        "paket"
+        "fantomas"
       ]
     },
-    "fsharp.formatting.commandtool": {
-      "version": "11.5.1",
+    "fsdocs-tool": {
+      "version": "15.0.0",
       "commands": [
         "fsdocs"
       ]
-    },
-    "fantomas-tool": {
-      "version": "4.5.8",
-      "commands": [
-        "fantomas"
-      ]
     }
   }
 }

Diff for: .github/workflows/build-and-test.yml

@@ -6,41 +6,34 @@ on:
   pull_request:
     branches: [ dev ]
 
+
 jobs:
   build-and-test-linux:
 
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 3.1
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.x'
-    - name: Setup .NET 5
+    - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '5.0.201'
-    - name: Restore local tools
-      run: dotnet tool restore
+        dotnet-version: 6.x.x
+    - name: make script executable
+      run: chmod u+x build.sh
     - name: Build and test
-      run: dotnet fake build -t runTests
+      working-directory: ./
+      run: ./build.sh runtests
 
   build-and-test-windows:
 
     runs-on: windows-latest
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 3.1
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.x'
-    - name: Setup .NET 5
+    - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '5.0.201'
-    - name: Restore local tools
-      run: dotnet tool restore
+        dotnet-version: 6.x.x
     - name: Build and test
-      run: dotnet fake build -t runTests
+      working-directory: ./
+      run: ./build.cmd runtests

Diff for: .gitignore

@@ -16,7 +16,6 @@
 [Dd]ebug/
 [Rr]elease/
 x64/
-build/
 [Bb]in/
 [Oo]bj/
 

Diff for: Plotly.NET.sln

@@ -19,10 +19,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "git", "git", "{078A9C52-DDC
 		.gitignore = .gitignore
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".build", ".build", "{7C6D08E7-3EAC-4335-8F4B-252C193C27C9}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "build", "build", "{7C6D08E7-3EAC-4335-8F4B-252C193C27C9}"
 	ProjectSection(SolutionItems) = preProject
 		build.cmd = build.cmd
-		build.fsx = build.fsx
 		build.sh = build.sh
 	EndProjectSection
 EndProject
@@ -149,6 +148,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Plotly.NET.Tests.CSharp", "
 EndProject
 Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Plotly.NET.ImageExport.Tests", "tests\Plotly.NET.ImageExport.Tests\Plotly.NET.ImageExport.Tests.fsproj", "{55A461C3-8018-4020-B16E-D6005BDFCAED}"
 EndProject
+Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "build", "build\build.fsproj", "{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -204,6 +205,12 @@ Global
 		{55A461C3-8018-4020-B16E-D6005BDFCAED}.Dotnet|Any CPU.Build.0 = Debug|Any CPU
 		{55A461C3-8018-4020-B16E-D6005BDFCAED}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{55A461C3-8018-4020-B16E-D6005BDFCAED}.Release|Any CPU.Build.0 = Release|Any CPU
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}.Dotnet|Any CPU.ActiveCfg = Debug|Any CPU
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}.Dotnet|Any CPU.Build.0 = Debug|Any CPU
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -220,6 +227,7 @@ Global
 		{1BC73DA0-586F-45C2-BC5B-A70C452A00F0} = {EAE25A1F-86FC-426B-803F-1006D1AD06A8}
 		{26539796-0C9D-4856-8584-B58BE32CC495} = {EAE25A1F-86FC-426B-803F-1006D1AD06A8}
 		{55A461C3-8018-4020-B16E-D6005BDFCAED} = {EAE25A1F-86FC-426B-803F-1006D1AD06A8}
+		{403785C9-B5B1-4BA4-9944-A0F9D5D1B3CD} = {7C6D08E7-3EAC-4335-8F4B-252C193C27C9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {7177F1E1-341C-48AB-9864-6B525FFF7633}

Diff for: README.md

@@ -26,8 +26,6 @@ Plotly.NET provides functions for generating and rendering plotly.js charts in *
     - [docs](#docs)
 - [Library license](#library-license)
 
-
-
 # Installation
 
 Plotly.NET will be available as 2.0.0 version of its predecessor FSharp.Plotly. The feature roadmap can be seen [here](https://github.com/plotly/Plotly.NET/issues/43). Contributions are very welcome!
@@ -98,31 +96,31 @@ _Note:_ The `release` and `prerelease` build targets assume that there is a `NUG
 
 ### build
 
-Check the [build.fsx file](https://github.com/plotly/Plotly.NET/blob/dev/build.fsx) to take a look at the  build targets. Here are some examples:
+Check the [build project](https://github.com/plotly/Plotly.NET/blob/dev/build) to take a look at the  build targets. Here are some examples:
 
 ```shell
 # Windows
 
 # Build only
 ./build.cmd
 
-# Full release buildchain: build, test, pack, build the docs, push a git tag, publsih thze nuget package, release the docs
-./build.cmd -t release
+# Full release buildchain: build, test, pack, build the docs, push a git tag, publish thze nuget package, release the docs
+./build.cmd release
 
 # The same for prerelease versions:
-./build.cmd -t prerelease
+./build.cmd prerelease
 
 
 # Linux/mac
 
 # Build only
 build.sh
 
-# Full release buildchain: build, test, pack, build the docs, push a git tag, publsih thze nuget package, release the docs
-build.sh -t release
+# Full release buildchain: build, test, pack, build the docs, push a git tag, publísh the nuget package, release the docs
+build.sh release
 
 # The same for prerelease versions:
-build.sh -t prerelease
+build.sh prerelease
 
 ```
 
@@ -132,15 +130,12 @@ The docs are contained in `.fsx` and `.md` files in the `docs` folder. To develo
 
 ```shell
 # Windows
-./build.cmd -t watchdocs
+./build.cmd watchdocs
 
 # Linux/mac
-./build.sh -t watchdocs
+./build.sh watchdocs
 ```
 
-
-### release
-
 Library license
 ===============
 

Diff for: build.cmd

@@ -1,6 +1,4 @@
 @echo off
 cls
 
-dotnet tool restore
-dotnet restore
-dotnet fake build %*
+dotnet run --project ./build/build.fsproj %*

Diff for: build.sh

@@ -1,11 +1,6 @@
 #!/usr/bin/env bash
-# to properly set Travis permissions: https://stackoverflow.com/questions/33820638/travis-yml-gradlew-permission-denied
-# git update-index --chmod=+x fake.sh
-# git commit -m "permission access for travis"
 
 set -eu
 set -o pipefail
 
-dotnet tool restore
-dotnet restore
-dotnet fake build "$@"
+dotnet run --project ./build/build.fsproj "$@"

Diff for: build/BasicTasks.fs

@@ -0,0 +1,30 @@
+module BasicTasks
+
+open BlackFox.Fake
+open Fake.IO
+open Fake.DotNet
+open Fake.IO.Globbing.Operators
+
+open ProjectInfo
+
+let setPrereleaseTag = BuildTask.create "SetPrereleaseTag" [] {
+    printfn "Please enter pre-release package suffix"
+    let suffix = System.Console.ReadLine()
+    prereleaseSuffix <- suffix
+    prereleaseTag <- (sprintf "%s-%s" release.NugetVersion suffix)
+    isPrerelease <- true
+}
+
+let clean = BuildTask.create "Clean" [] {
+    !! "src/**/bin"
+    ++ "src/**/obj"
+    ++ "tests/**/bin"
+    ++ "tests/**/obj"
+    ++ "pkg"
+    |> Shell.cleanDirs 
+}
+
+let build = BuildTask.create "Build" [clean] {
+    solutionFile
+    |> DotNet.build id
+}

Diff for: build/Build.fs

@@ -0,0 +1,46 @@
+open BlackFox.Fake
+open System.IO
+open Fake.Core
+open Fake.DotNet
+open Fake.IO
+open Fake.IO.FileSystemOperators
+open Fake.IO.Globbing.Operators
+open Fake.Tools
+
+open Helpers
+
+initializeContext()
+
+open BasicTasks
+open TestTasks
+open PackageTasks
+open DocumentationTasks
+open ReleaseTasks
+
+/// Full release of nuget package, git tag, and documentation for the stable version.
+let _release = 
+    BuildTask.createEmpty 
+        "Release" 
+        [clean; build; runTests; pack; buildDocs; createTag; publishNuget; releaseDocs]
+
+/// Full release of nuget package, git tag, and documentation for the prerelease version.
+let _preRelease = 
+    BuildTask.createEmpty 
+        "PreRelease" 
+        [setPrereleaseTag; clean; build; runTests; packPrerelease; buildDocsPrerelease; createPrereleaseTag; publishNugetPrerelease; prereleaseDocs]
+
+/// Full release of nuget package for the prerelease version.
+let _releaseNoDocs = 
+    BuildTask.createEmpty 
+        "ReleaseNoDocs" 
+        [clean; build; runTests; pack; createTag; publishNuget;]
+
+/// Full release of nuget package for the prerelease version.
+let _preReleaseNoDocs = 
+    BuildTask.createEmpty 
+        "PreReleaseNoDocs" 
+        [setPrereleaseTag; clean; build; runTests; packPrerelease; createPrereleaseTag; publishNugetPrerelease]
+
+[<EntryPoint>]
+let main args = 
+    runOrDefault build args

Diff for: build/DocumentationTasks.fs

@@ -0,0 +1,35 @@
+module DocumentationTasks
+
+open Helpers
+open ProjectInfo
+open BasicTasks
+
+open BlackFox.Fake
+
+let buildDocs = BuildTask.create "BuildDocs" [build] {
+    printfn "building docs with stable version %s" stableVersionTag
+    runDotNet 
+        (sprintf "fsdocs build --eval --clean --properties Configuration=Release --parameters fsdocs-package-version %s" stableVersionTag)
+        "./"
+}
+
+let buildDocsPrerelease = BuildTask.create "BuildDocsPrerelease" [setPrereleaseTag; build] {
+    printfn "building docs with prerelease version %s" prereleaseTag
+    runDotNet 
+        (sprintf "fsdocs build --eval --clean --properties Configuration=Release --parameters fsdocs-package-version %s" prereleaseTag)
+        "./"
+}
+
+let watchDocs = BuildTask.create "WatchDocs" [build] {
+    printfn "watching docs with stable version %s" stableVersionTag
+    runDotNet 
+        (sprintf "fsdocs watch --eval --clean --properties Configuration=Release --parameters fsdocs-package-version %s" stableVersionTag)
+        "./"
+}
+
+let watchDocsPrerelease = BuildTask.create "WatchDocsPrerelease" [setPrereleaseTag; build] {
+    printfn "watching docs with prerelease version %s" prereleaseTag
+    runDotNet 
+        (sprintf "fsdocs watch --eval --clean --properties Configuration=Release --parameters fsdocs-package-version %s" prereleaseTag)
+        "./"
+}

Diff for: build/FormattingTasks.fs

@@ -0,0 +1,50 @@
+module FormattingTasks
+
+open MessagePrompts
+open ProjectInfo
+open BasicTasks
+
+open BlackFox.Fake
+open Fake.Core
+open Fake.DotNet
+open Fake.Api
+open Fake.Tools
+open Fake.IO
+open Fake.IO.Globbing.Operators
+
+// files that will be formatted by fantomas
+let sourceFiles =
+    !! "src/Plotly.NET/**/*.fs"
+    ++ "src/Plotly.NET.ImageExport/**/*.fs"
+    ++ "src/Plotly.NET.Interactive/**/*.fs"
+    -- "**/obj/**/*.*"
+    -- "**/bin/**/*.*"
+
+let ccheckFormat =
+    BuildTask.create "CheckFormat" [] {
+        let result =
+            sourceFiles
+            |> Seq.map (sprintf "\"%s\"")
+            |> String.concat " "
+            |> sprintf "%s --check"
+            |> DotNet.exec id "fantomas"
+    
+        if result.ExitCode = 0 then
+            Trace.log "No files need formatting"
+        elif result.ExitCode = 99 then
+            failwith "Some files need formatting, check output for more info"
+        else
+            Trace.logf "Errors while formatting: %A" result.Errors
+         }
+
+let format =
+    BuildTask.create "Format" [] {
+        let result =
+            sourceFiles
+            |> Seq.map (sprintf "\"%s\"")
+            |> String.concat " "
+            |> DotNet.exec id "fantomas"
+    
+        if not result.OK then
+            printfn "Errors while formatting all files: %A" result.Messages
+            }