Merge pull request #142 from dsyme/docs

Update build/publish process

Author: dsyme

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "fsharp.formatting.commandtool": {
-      "version": "11.1.0",
+      "version": "11.4.1",
       "commands": [
         "fsdocs"
       ]

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Build and Publish Docs
+name: Build and Publish
 on:
   push:
     branches: [ master ]
@@ -7,17 +7,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.x'
-    - name: Setup .NET 
+    - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '5.0.202'
     - name: Install tools
       run: dotnet tool restore
-    - name: Build and Test and Docs using FAKE 
+    - name: Build and Test and Docs using FAKE
       run: dotnet fake build
     - name: Deploy
       uses: peaceiris/actions-gh-pages@v3
@@ -26,3 +22,11 @@ jobs:
         publish_dir: ./output
         publish_branch: gh-pages
         force_orphan: true
+    - name: Examine bin
+      run: ls -r bin
+    - name: Publish NuGets (if this version not published before)
+      run: dotnet nuget push bin\FSharp.Control.AsyncSeq.*.nupkg -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_ORG_TOKEN_2021 }} --skip-duplicate
+
+# NUGET_ORG_TOKEN_2021 is listed in "Repository secrets" in https://github.com/fsprojects/FSharp.Control.AsyncSeq/settings/secrets/actions
+# note, the nuget org token expires around 24 July 2022
+

.gitignore

@@ -198,11 +198,12 @@ xunit*.html
 
 # exclude artifacts folder
 artifacts/
+bin/
 
 # jest/fable directories
 tests/fable/dist/
 tests/fable/node_modules/
 output/
 tmp/
 .fsdocs/
-build.fsx.lock
+build.fsx.lock

RELEASE_NOTES.md

@@ -1,3 +1,7 @@
+
+### 3.0.5
+* Update publishing
+
 ### 3.0.4
 * Restore netstandard2.0 (and thereby .NET Framework 4.6.1+) compatibility
 * Update build env versions to current recommendations
@@ -7,7 +11,7 @@
 
 * Include .fsi files into Fable package path [#118](https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/118)
 
-### 3.0.1 
+### 3.0.1
 
 * Move to only netstandard 2.1
 
@@ -96,9 +100,9 @@
 * Rename toArray to toArrayAsync
 * Rename zipWithIndexAsync to mapiAsync
 * Rename interleave to interleaveChoice
-* Add interleave 
-* Add mergeChoice 
-* Fix performance of mergeAll 
+* Add interleave
+* Add mergeChoice
+* Fix performance of mergeAll
 * Add init, initInfinite
 * Add initAsync, initInfiniteAsync, replicateInfinite
 * Add RequireQualifiedAccess to AsyncSeq
@@ -110,12 +114,12 @@
 * Cancellable AsyncSeq.toBlockingSeq
 * Fix AsyncSeq.scanAsync to also return first state
 * Add a signature file
-* AsyncSeq got extracted as separate project and is now a dependency - https://github.com/fsprojects/FSharpx.Async/pull/24 
+* AsyncSeq got extracted as separate project and is now a dependency - https://github.com/fsprojects/FSharpx.Async/pull/24
 
 ### 1.13 - 27.03.2015
 * Renamed to FSharp.Control.AsyncSeq
 * Remove surface area
-* Hide Nil/Cons from representation of AsyncSeq 
+* Hide Nil/Cons from representation of AsyncSeq
 
 ### 1.12.1 - 27.03.2015
 * Added Async.bindChoice, Async.ParallelIgnore, AsyncSeq.zipWithAsync, AsyncSeq.zappAsync, AsyncSeq.threadStateAsync, AsyncSeq.merge, AsyncSeq.traverseOptionAsync, AsyncSeq.traverseChoiceAsync

appveyor.yml

@@ -24,15 +24,11 @@ open Fake.Tools
 open System
 open System.IO
 
-// --------------------------------------------------------------------------------------
-// START TODO: Provide project-specific details below
-// --------------------------------------------------------------------------------------
-
 // The name of the project
 // (used by attributes in AssemblyInfo, name of a NuGet package and directory in 'src')
 let project = "src/FSharp.Control.AsyncSeq"
 
-// File system information 
+// File system information
 let solutionFile = "FSharp.Control.AsyncSeq.sln"
 
 let summary = "Asynchronous sequences for F#"
@@ -45,8 +41,8 @@ let projectRepo = "https://github.com/fsprojects/FSharp.Control.AsyncSeq"
 
 let configuration = DotNet.BuildConfiguration.fromEnvironVarOrDefault "configuration" DotNet.BuildConfiguration.Release
 
-// Folder to deposit deploy artifacts
-let artifactsDir = __SOURCE_DIRECTORY__ @@ "artifacts"
+// Folder to deposit deploy bin
+let binDir = __SOURCE_DIRECTORY__ @@ "bin"
 
 // Read additional information from the release notes document
 let release = ReleaseNotes.load "RELEASE_NOTES.md"
@@ -64,7 +60,7 @@ let versionPropsTemplate = $"\
 
 Target.create "Clean" (fun _ ->
     DotNet.exec id "clean" "" |> ignore
-    Shell.cleanDirs ["artifacts"; "temp"]
+    Shell.cleanDirs ["bin"; "temp"]
 )
 
 // Generate assembly info files with the right version & up-to-date information
@@ -97,7 +93,7 @@ Target.create "Build" (fun _ ->
 // --------------------------------------------------------------------------------------
 // Run the unit tests using test runner
 
-Target.create "RunTests" (fun _ ->
+Target.create "Test" (fun _ ->
     solutionFile
     |> DotNet.test (fun opts ->
         { opts with
@@ -112,13 +108,13 @@ Target.create "RunTests" (fun _ ->
 // --------------------------------------------------------------------------------------
 // Build a NuGet package
 
-Target.create "NuGet" (fun _ ->
-    
+Target.create "Pack" (fun _ ->
+
     File.WriteAllText("version.props",versionPropsTemplate)
     DotNet.pack (fun pack ->
         { pack with
-            OutputPath = Some artifactsDir 
-            Configuration = configuration 
+            OutputPath = Some binDir
+            Configuration = configuration
         }) solutionFile
 )
 
@@ -127,34 +123,7 @@ Target.create "NuGet" (fun _ ->
 
 Target.create "GenerateDocs" (fun _ ->
     Shell.cleanDir ".fsdocs"
-    DotNet.exec id "fsdocs" "build --clean --properties Configuration=Release" |> ignore
-)
-
-// --------------------------------------------------------------------------------------
-// Release 
-
-Target.create "PublishNuget" (fun _ ->
-    let source = "https://api.nuget.org/v3/index.json"
-    let apikey =  Environment.environVar "NUGET_KEY"
-    for artifact in !! (artifactsDir + "/*nupkg") do
-        if not (artifact.Contains(".symbols")) then 
-           let result = DotNet.exec id "nuget" (sprintf "push -s %s -k %s %s" source apikey artifact)
-           if not result.OK then failwith "failed to push packages"  
-)
-Target.create "ReleaseDocs" (fun _ ->
-    Git.Repository.clone "" projectRepo "temp/gh-pages"
-    Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
-    Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
-    Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
-    let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
-    Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
-    Git.Branches.push "temp/gh-pages"
-)
-
-Target.create "Release" (fun _ ->
-    Git.Branches.tag "" release.NugetVersion
-    Git.Branches.pushTag "" projectRepo release.NugetVersion
-    
+    DotNet.exec id "fsdocs" "build --clean --properties Configuration=Release --eval" |> ignore
 )
 
 // --------------------------------------------------------------------------------------
@@ -164,16 +133,13 @@ Target.create "All" ignore
 
 "Clean"
   ==> "Build"
-  ==> "RunTests"
-  ==> "NuGet"
-  ==> "GenerateDocs"
+  ==> "Test"
+  ==> "Pack"
   ==> "All"
 
-"NuGet" ==> "PublishNuget"
-"GenerateDocs" ==> "ReleaseDocs"
-
-"PublishNuget"
-  ==> "ReleaseDocs"
-  ==> "Release"
+"Clean"
+  ==> "Build"
+  ==> "GenerateDocs"
+  ==> "All"
 
 Target.runOrDefault "All"

build.fsx

@@ -1 +0,0 @@
-{{code}}

docs/_template.fsx

@@ -1 +0,0 @@
-{{cells}}

docs/_template.ipynb

@@ -9,7 +9,7 @@ nuget Microsoft.Bcl.AsyncInterfaces ~> 5.0.0 framework: netstandard2.0
 
 group Test
     source https://api.nuget.org/v3/index.json
-    framework: netcoreapp3.1, net5.0
+    framework: net5.0
     storage: none
 
     generate_load_scripts: true
@@ -41,4 +41,4 @@ group Fake
     nuget Fake.DotNet.NuGet            ~> 5.20.4
     nuget Fake.DotNet.MsBuild          ~> 5.20.4
     nuget Fake.Tools.Git               ~> 5.20.4
-	nuget Fake.DotNet.Paket            ~> 5.20.4
+	nuget Fake.DotNet.Paket            ~> 5.20.4

paket.dependencies

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net5.0</TargetFrameworks>
+    <TargetFrameworks>net5.0</TargetFrameworks>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
   <ItemGroup>