diff --git a/Fake.sln b/Fake.sln index 530af044708..fc85cae3663 100644 --- a/Fake.sln +++ b/Fake.sln @@ -28,7 +28,7 @@ Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Fake.DotNet.AssemblyInfoFil EndProject Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Fake.DotNet.Cli", "src/app/Fake.DotNet.Cli/Fake.DotNet.Cli.fsproj", "{B2C0063A-FC66-4883-BB69-B1DBE6BF9CA2}" EndProject -Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Fake.DotNet.MsBuild", "src/app/Fake.DotNet.MsBuild/Fake.DotNet.MsBuild.fsproj", "{64195C50-E138-4218-A7CE-13CD4565B87E}" +Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Fake.DotNet.MSBuild", "src/app/Fake.DotNet.MSBuild/Fake.DotNet.MSBuild.fsproj", "{64195C50-E138-4218-A7CE-13CD4565B87E}" EndProject Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Fake.DotNet.NuGet", "src/app/Fake.DotNet.NuGet/Fake.DotNet.NuGet.fsproj", "{93F1A71E-54E2-4C65-BB1E-1D499890317F}" EndProject diff --git a/help/markdown/core-targets.md b/help/markdown/core-targets.md index 3f15f9dd108..921dafad7d2 100644 --- a/help/markdown/core-targets.md +++ b/help/markdown/core-targets.md @@ -22,15 +22,15 @@ nuget Fake.Core.Target //" open Fake.Core // *** Define Targets *** -Target.create "Clean" (fun _ -> +Target.create "Clean" (fun _ -> Trace.trace " --- Cleaning stuff --- " ) -Target.create "Build" (fun _ -> +Target.create "Build" (fun _ -> Trace.trace " --- Building the app --- " ) -Target.create "Deploy" (fun _ -> +Target.create "Deploy" (fun _ -> Trace.trace " --- Deploying app --- " ) @@ -58,7 +58,7 @@ Now we have the following options: ## Final targets -Final targets can be used for TearDown functionality. +Final targets can be used for TearDown functionality. These targets will be executed even if the build fails but have to be activated via Target.ActivateFinal(). ```fsharp @@ -96,7 +96,7 @@ still be exectued in order. ### Setting the number of threads The number of threads used can be set using the environment variable ``parallel-jobs``. -This can be achieved in various ways where the easiest one is to use FAKE's built-in support for +This can be achieved in various ways where the easiest one is to use FAKE's built-in support for setting environment variables: ``fake *YourBuildScript* -e parallel-jobs 8`` @@ -140,7 +140,7 @@ For example this dependency tree: ![](pics/parallel/ParallelExample.png) -This is in addition to that that MsBuild may use multiple threads when building one solution having multiple independent project-files. +This is in addition to that that MSBuild may use multiple threads when building one solution having multiple independent project-files. # Soft dependencies @@ -148,7 +148,7 @@ Typically you will define dependencies among your targets using the `==>` and `< dependencies define the order in which the targets are executed during a build. You can also define soft dependencies among targets using the `?=>` and `<=?` operators. For example, you might -say that target B has a soft dependency on target A: +say that target B has a soft dependency on target A: ```fsharp "A" ?=> "B" @@ -156,18 +156,18 @@ say that target B has a soft dependency on target A: "B" <=? "A" ``` -With this soft dependency, running B will not require that A be run first. However it does mean that *if* A is run +With this soft dependency, running B will not require that A be run first. However it does mean that *if* A is run (due to other dependencies) it must be run before B. ## Example ```fsharp // *** Define Targets *** -Target.create "Clean" (fun _ -> +Target.create "Clean" (fun _ -> Trace.trace " --- Cleaning stuff --- " ) -Target.create "Build" (fun _ -> +Target.create "Build" (fun _ -> Trace.trace " --- Building the app --- " ) diff --git a/help/markdown/dotnet-assemblyinfo.md b/help/markdown/dotnet-assemblyinfo.md index 2e38cb7ee6a..7fa4c6d357f 100644 --- a/help/markdown/dotnet-assemblyinfo.md +++ b/help/markdown/dotnet-assemblyinfo.md @@ -9,7 +9,7 @@ If you succeeded with the [Getting Started tutorial](gettingstarted.html), then ```fsharp #r "paket: nuget Fake.DotNet.AssemblyInfo -nuget Fake.DotNet.MsBuild +nuget Fake.DotNet.MSBuild nuget Fake.Core.Target //" open Fake.DotNet @@ -30,7 +30,7 @@ Target.Create "BuildApp" (fun _ -> AssemblyInfo.Version version AssemblyInfo.FileVersion version] - MsBuild.RunRelease buildDir "Build" appReferences + MSBuild.RunRelease buildDir "Build" appReferences |> Log "AppBuild-Output: " ) ``` @@ -73,7 +73,7 @@ One of the easiest ways to retrieve this hash is to load use a reflector program ## Using the SolutionInfo approach -Some companies split their AssemblyInfo into a SolutionInfo.cs which is shared by all projects and a specific AssemblyInfo per project which contains the product data. +Some companies split their AssemblyInfo into a SolutionInfo.cs which is shared by all projects and a specific AssemblyInfo per project which contains the product data. All versioning data is generated by the AssemblyInfo task into the SolutionInfo.cs and the AssemblyInfo files are edited manually. This could look like this: ![alt text](pics/assemblyinfo/solutioninfo.png "SolutionInfo.cs is shared between projects") diff --git a/help/markdown/fake-gettingstarted.md b/help/markdown/fake-gettingstarted.md index 395919f212d..7f42168c165 100644 --- a/help/markdown/fake-gettingstarted.md +++ b/help/markdown/fake-gettingstarted.md @@ -159,15 +159,15 @@ In the dependencies section we say that the *Default* target has a dependency on In the next step we want to compile our C# libraries, which means we want to compile all csproj-files under */src/app* with MSBuild. -Again we need some new module for this, namely `Fake.DotNet.MsBuild`. +Again we need some new module for this, namely `Fake.DotNet.MSBuild`. -Just like before add the required module on top via `nuget Fake.DotNet.MsBuild`, delete the `build.fsx.lock` file and run the script. +Just like before add the required module on top via `nuget Fake.DotNet.MSBuild`, delete the `build.fsx.lock` file and run the script. Now edit the script like this: ```fsharp #r "paket: nuget Fake.IO.FileSystem -nuget Fake.DotNet.MsBuild +nuget Fake.DotNet.MSBuild nuget Fake.Core.Target //" #load "./.fake/build.fsx/intellisense.fsx" @@ -186,7 +186,7 @@ Target.create "Clean" (fun _ -> Target.create "BuildApp" (fun _ -> !! "src/app/**/*.csproj" - |> MsBuild.runRelease buildDir "Build" + |> MSBuild.runRelease buildDir "Build" |> Trace.Log "AppBuild-Output: " ) @@ -221,7 +221,7 @@ Now our main application will be built automatically and it's time to build the ```fsharp #r "paket: nuget Fake.IO.FileSystem -nuget Fake.DotNet.MsBuild +nuget Fake.DotNet.MSBuild nuget Fake.Core.Target //" #load "./.fake/build.fsx/intellisense.fsx" @@ -243,13 +243,13 @@ Target.create "Clean" (fun _ -> Target.create "BuildApp" (fun _ -> !! "src/app/**/*.csproj" - |> MsBuild.runRelease buildDir "Build" + |> MSBuild.runRelease buildDir "Build" |> Trace.logItems "AppBuild-Output: " ) Target.create "BuildTest" (fun _ -> !! "src/test/**/*.csproj" - |> MsBuild.runDebug testDir "Build" + |> MSBuild.runDebug testDir "Build" |> Trace.logItems "TestBuild-Output: " ) @@ -276,7 +276,7 @@ Now all our projects will be compiled and we can use FAKE's NUnit task in order ```fsharp #r "paket: nuget Fake.IO.FileSystem -nuget Fake.DotNet.MsBuild +nuget Fake.DotNet.MSBuild nuget Fake.DotNet.Testing.NUnit nuget Fake.Core.Target //" #load "./.fake/myscript.fsx/intellisense.fsx" @@ -298,13 +298,13 @@ Target.create "Clean" (fun _ -> Target.create "BuildApp" (fun _ -> !! "src/app/**/*.csproj" - |> MsBuild.runRelease buildDir "Build" + |> MSBuild.runRelease buildDir "Build" |> Trace.logItems "AppBuild-Output: " ) Target.create "BuildTest" (fun _ -> !! "src/test/**/*.csproj" - |> MsBuild.runDebug testDir "Build" + |> MSBuild.runDebug testDir "Build" |> Trace.logItems "TestBuild-Output: " ) diff --git a/help/markdown/legacy-core-targets.md b/help/markdown/legacy-core-targets.md index cda0352bad1..e641adcc757 100644 --- a/help/markdown/legacy-core-targets.md +++ b/help/markdown/legacy-core-targets.md @@ -17,18 +17,18 @@ FAKE has a special param "target" which can be used to run specific targets in a // include Fake libs #I @"tools\FAKE" #r "FakeLib.dll" - open Fake + open Fake // *** Define Targets *** - Target "Clean" (fun () -> + Target "Clean" (fun () -> trace " --- Cleaning stuff --- " ) - Target "Build" (fun () -> + Target "Build" (fun () -> trace " --- Building the app --- " ) - Target "Deploy" (fun () -> + Target "Deploy" (fun () -> trace " --- Deploying app --- " ) @@ -50,7 +50,7 @@ Now we have the following options: ## Final targets -Final targets can be used for TearDown functionality. +Final targets can be used for TearDown functionality. These targets will be executed even if the build fails but have to be activated via ActivateFinalTarget(). FinalTarget "CloseSomePrograms" (fun _ -> @@ -83,7 +83,7 @@ the build script contains a call like this: ``` RunTargetOrDefault "Default" -``` +``` ### Example @@ -118,7 +118,7 @@ still be exectued in order. ## Setting the number of threads The number of threads used can be set using the environment variable ``parallel-jobs``. -This can be achieved in various ways where the easiest one is to use FAKE's built-in support for +This can be achieved in various ways where the easiest one is to use FAKE's built-in support for setting environment variables: ``FAKE.exe *YourBuildScript* "parallel-jobs=8"`` @@ -137,7 +137,7 @@ However when a fast build is desired (and the project is e.g. known to build suc When using this parallel option, Fake resolves the build dependency hierearchies from the described paths and builds independend paths as parallel if you have multiple CPUs available. For example this dependency tree: - + "Task 1" ==> "Task A2" ==> "Task 3" @@ -158,14 +158,14 @@ For example this dependency tree: ![](pics/parallel/ParallelExample.png) -This is in addition to that that MsBuild may use multiple threads when building one solution having multiple independent project-files. +This is in addition to that that MSBuild may use multiple threads when building one solution having multiple independent project-files. # Writing custom C# tasks for FAKE **Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! ** -"FAKE - F# Make" is intended to be an extensible build framework and therefor it should be as easy as possible to create custom tasks. +"FAKE - F# Make" is intended to be an extensible build framework and therefor it should be as easy as possible to create custom tasks. This tutorial shows how to create a (very simple) custom task in C#. ## Creating a custom task @@ -198,7 +198,7 @@ Compile the project and put the generated assembly into the *tools/FAKE* path of // include CustomTask #r "MyCustomTask.dll" - open Fake + open Fake // open CustomNamespace open MyCustomTask @@ -212,27 +212,27 @@ If you want to use FAKE's standard functionality (like [globbing](http://en.wiki # Soft dependencies -Typically you will define dependencies among your targets using the `==>` and `<==` operators, and these +Typically you will define dependencies among your targets using the `==>` and `<==` operators, and these dependencies define the order in which the targets are executed during a build. You can also define soft dependencies among targets using the `?=>` and `<=?` operators. For example, you might -say that target B has a soft dependency on target A: - +say that target B has a soft dependency on target A: + "A" ?=> "B" // Or equivalently "B" <=? "A" -With this soft dependency, running B will not require that A be run first. However it does mean that *if* A is run +With this soft dependency, running B will not require that A be run first. However it does mean that *if* A is run (due to other dependencies) it must be run before B. ## Example // *** Define Targets *** - Target "Clean" (fun () -> + Target "Clean" (fun () -> trace " --- Cleaning stuff --- " ) - Target "Build" (fun () -> + Target "Build" (fun () -> trace " --- Building the app --- " ) diff --git a/help/templates/template.cshtml b/help/templates/template.cshtml index ecadabd4ce0..61c5f0263f3 100644 --- a/help/templates/template.cshtml +++ b/help/templates/template.cshtml @@ -104,7 +104,7 @@ -