finish implementation of individual-project-version flag

Author: kMutagene

BuildProject.fsproj

@@ -18,8 +18,8 @@
     <PackageTags>build f#</PackageTags>
     <RepositoryUrl>https://github.com/kMutagene/BuildProject</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <PackageVersion>2.0.0</PackageVersion>
-    <PackageReleaseNotes>Update fake dependencies and add TFM argument</PackageReleaseNotes>
+    <PackageVersion>3.0.0</PackageVersion>
+    <PackageReleaseNotes>Add `` flag for enabling projects being build and released with individual versions and release notes</PackageReleaseNotes>
   </PropertyGroup>
   <PropertyGroup>
     <ExcludeFromPackage>

Content/.template.config/template.json

@@ -27,16 +27,13 @@
       "description": "The target framework of the build project (net6.0 or net7.0). default is net6.0",
       "type": "parameter",
       "replaces": "{TFM}",
-      "datatype": "choice",
-      "choices": [
-        "net6.0",
-        "net7.0"
-      ],
       "defaultValue": "net6.0"
     },
-    "individuaPackageVersions": {
+    "individual-package-versions": {
       "description": "If set, the build project will support individual package versions and release notes per project.",
-      "type": "parameter"
+      "type": "parameter",
+      "dataType": "bool",
+      "defaultValue": "false"
     }
   }
 }

Content/BasicTasks.fs

@@ -7,14 +7,6 @@ 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"
@@ -24,7 +16,22 @@ let clean = BuildTask.create "Clean" [] {
     |> Shell.cleanDirs 
 }
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
+
+/// Buildtask for setting a prerelease tag (also sets the mutable isPrerelease to true, and the PackagePrereleaseTag of all project infos accordingly.)
+let setPrereleaseTag =
+    BuildTask.create "SetPrereleaseTag" [] {
+        printfn "Please enter pre-release package suffix"
+        let suffix = System.Console.ReadLine()
+        prereleaseSuffix <- suffix
+        isPrerelease <- true
+        projects
+        |> List.iter (fun p ->
+            p.PackagePrereleaseTag <- (sprintf "%s-%s" p.PackageVersionTag suffix)
+        )
+        // 
+        prereleaseTag <- (sprintf "%s-%s" CoreProject.PackageVersionTag suffix)
+    }
 
 /// builds the solution file (dotnet build solution.sln)
 let buildSolution =
@@ -80,6 +87,14 @@ let build = BuildTask.create "Build" [clean] {
 
 #else
 
+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 build = BuildTask.create "Build" [clean] {
     solutionFile
     |> DotNet.build id

Content/DocumentationTasks.fs

@@ -6,7 +6,7 @@ open BasicTasks
 
 open BlackFox.Fake
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 let buildDocs =
     BuildTask.create "BuildDocs" [ build ] {

Content/PackageTasks.fs

@@ -8,9 +8,10 @@ open TestTasks
 
 open BlackFox.Fake
 open Fake.Core
+open Fake.DotNet
 open Fake.IO.Globbing.Operators
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 let pack = BuildTask.create "Pack" [ clean; build; runTests ] {
     projects

Content/ProjectInfo.fs

@@ -2,7 +2,7 @@
 
 open Fake.Core
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 /// Contains relevant information about a project (e.g. version info, project location)
 type ProjectInfo = {
@@ -51,13 +51,13 @@ type ProjectInfo = {
         }
 
 // adapt this to reflect the core project in your repository. The only effect this will have is the version displayed in the docs, as it is currently only possible to have one version displayed there.
-let coreProject = ProjectInfo.create("", "", "")
+let CoreProject = ProjectInfo.create("", "", "")
 
 let projects = 
     [
         // add relative paths (from project root) to your projects here, including individual reslease notes files
         // e.g. ProjectInfo.create("MyProject", "src/MyProject/MyProject.fsproj", "src/MyProject/RELEASE_NOTES.md")
-        coreProject
+        CoreProject
     ]
 
 #endif
@@ -67,7 +67,7 @@ let project = "{PROJECTNAME}"
 let testProjects = 
     [
         // add relative paths (from project root) to your testprojects here
-#if (individuaPackageVersions)
+#if (individual-package-versions)
         // e.g. ProjectInfo.create("MyTestProject", "tests/MyTestProject/MyTestProject.fsproj")
 #endif
     ]
@@ -84,7 +84,7 @@ let projectRepo = $"https://github.com/{gitOwner}/{project}"
 
 let pkgDir = "pkg"
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 /// docs are always targeting the version of the core project
 let stableDocsVersionTag = CoreProject.PackageVersionTag

Content/ReleaseNotesTasks.fs

@@ -1,6 +1,6 @@
 module ReleaseNotesTasks
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 // indivudual project release notes do not support automated release notes generation at the moment.
 

Content/ReleaseTasks.fs

@@ -15,7 +15,7 @@ open Fake.Tools
 open Fake.IO
 open Fake.IO.Globbing.Operators
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 let createTag =
     BuildTask.create "CreateTag" [ clean; build; runTests; pack ] {
@@ -119,6 +119,32 @@ let publishNugetPrerelease =
             failwith "aborted"
     }
 
+let releaseDocs =  BuildTask.create "ReleaseDocs" [buildDocs] {
+    let msg = 
+        sprintf "release docs for version %s?" stableDocsVersionTag
+    if promptYesNo msg then
+        Shell.cleanDir "temp"
+        Git.CommandHelper.runSimpleGitCommand "." (sprintf "clone %s temp/gh-pages --depth 1 -b gh-pages" projectRepo) |> ignore
+        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""" stableDocsVersionTag
+        Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
+        Git.Branches.push "temp/gh-pages"
+    else failwith "aborted"
+}
+
+let prereleaseDocs =  BuildTask.create "PrereleaseDocs" [buildDocsPrerelease] {
+    let msg = sprintf "release docs for version %s?" prereleaseTag
+    if promptYesNo msg then
+        Shell.cleanDir "temp"
+        Git.CommandHelper.runSimpleGitCommand "." (sprintf "clone %s temp/gh-pages --depth 1 -b gh-pages" projectRepo) |> ignore
+        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""" prereleaseTag
+        Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
+        Git.Branches.push "temp/gh-pages"
+    else failwith "aborted"
+}
 #else
 let createTag = BuildTask.create "CreateTag" [clean; build; runTests; pack] {
     if promptYesNo (sprintf "tagging branch with %s OK?" stableVersionTag ) then
@@ -162,10 +188,11 @@ let publishNugetPrerelease = BuildTask.create "PublishNugetPrerelease" [clean; b
             if not result.OK then failwith "failed to push packages"
     else failwith "aborted"
 }
-#endif
 
 let releaseDocs =  BuildTask.create "ReleaseDocs" [buildDocs] {
-    let msg = sprintf "release docs for version %s?" stableVersionTag
+    let msg = 
+        sprintf "release docs for version %s?" 
+            stableVersionTag
     if promptYesNo msg then
         Shell.cleanDir "temp"
         Git.CommandHelper.runSimpleGitCommand "." (sprintf "clone %s temp/gh-pages --depth 1 -b gh-pages" projectRepo) |> ignore
@@ -188,4 +215,5 @@ let prereleaseDocs =  BuildTask.create "PrereleaseDocs" [buildDocsPrerelease] {
         Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
         Git.Branches.push "temp/gh-pages"
     else failwith "aborted"
-}
+}
+#endif

Content/TestTasks.fs

@@ -6,7 +6,7 @@ open Fake.DotNet
 open ProjectInfo
 open BasicTasks
 
-#if (individuaPackageVersions)
+#if (individual-package-versions)
 
 let buildTests = 
     BuildTask.create "BuildTests" [clean; build] {