+This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
In this article you will learn how to create a [Slack](https://slack.com) webhook integration and send a notification to it. This article assumes that you already have a Slack team setup.
-**Note: This documentation is for FAKE 5. The old documentation can be found [here](legacy-slacknotification.html)! **
-
[API-Reference](apidocs/v5/fake-api-slack.html)
## Adding a Webhook Integration to a Channel
diff --git a/help/markdown/contributing.md b/help/markdown/contributing.md
index 219082a36cb..771d81962f7 100644
--- a/help/markdown/contributing.md
+++ b/help/markdown/contributing.md
@@ -30,16 +30,23 @@ It turns `*.md` (Markdown with embedded code snippets) and `*.fsx` files (F# scr
* Clone your personal fork locally.
* Add a new git remote in order to retrieve upstream changes.
-
- git remote add upstream https://github.com/fsharp/FAKE.git
+
#### Build tools
* Windows users can install Visual Studio 2017 (the [Community Edition](https://www.visualstudio.com/de/vs/community/)
is freely available for open-source projects).
- > Make sure to have long path enabled: https://superuser.com/questions/1119883/windows-10-enable-ntfs-long-paths-policy-option-missing
- > Otherwise the test-suite will fail (However, the build should work)
+
+
INFO
+ Make sure to have long path enabled: https://superuser.com/questions/1119883/windows-10-enable-ntfs-long-paths-policy-option-missing
+ Otherwise the test-suite will fail (However, the build should work)
+
+
* Linux and Mac users can read "[Guide - Cross-Platform Development with F#](http://fsharp.org/guides/mac-linux-cross-platform/)"
to find out the required tools.
@@ -52,16 +59,24 @@ It turns `*.md` (Markdown with embedded code snippets) and `*.fsx` files (F# scr
* Alternately, you can use [Vagrant](https://www.vagrantup.com/) in-pair with [VirtualBox](https://www.virtualbox.org/)
to automatically deploy a preconfigured virtual machine. See the [Vagrant docs](vagrant.html) to get in touch with the tool.
-> Note: The vagrant file might be outdated at this time, please help updating it and removing this banner.
-
+
+
WARNING
+ The vagrant file might be outdated at this time, please help updating it and removing this banner.
+
* Ubuntu / Windows Subsystem for Linux:
+
* Install Mono, as of today 2017-09-30 you need at least alpha to have the msbuild package (http://www.mono-project.com/download/beta/#download-lin)
- * `apt-get install msbuild mono-complete`
- * `apt-cache search libunwind`
- * `# apt-get Install the libunwind runtime (one of the search results)`
- * `apt-cache search libcurl # Install`
- * `# apt-get Install the libcurl library (one of the search results)`
- * `./build.sh`
+ * Run the following
+
+
+ apt-get install msbuild mono-complete
+ apt-cache search libunwind
+ # apt-get Install the libunwind runtime (one of the search results)
+ apt-cache search libcurl # Install
+ # apt-get Install the libcurl library (one of the search results)
+ ./build.sh
+
+
### Programming
@@ -70,8 +85,11 @@ It turns `*.md` (Markdown with embedded code snippets) and `*.fsx` files (F# scr
* Run the build via `fake run build.fsx` in order to check if everything works.
* Create a new feature branch.
-
- git checkout -b myfeature
+
+
+ git checkout -b myfeature
+
+
* Implement your bugfix/feature.
@@ -85,10 +103,13 @@ It turns `*.md` (Markdown with embedded code snippets) and `*.fsx` files (F# scr
Write "WIP" into the pull request description if it's not completely ready
* If you need to rebase you can do:
-
- git fetch upstream
- git rebase upstream/master
- git push origin myfeature -f
+
* The pull request will be updated automatically.
@@ -98,9 +119,12 @@ It turns `*.md` (Markdown with embedded code snippets) and `*.fsx` files (F# scr
1. Create a local nuget package for the module you've changed.
e.g: Using dotnet cli
-
- cd path/to/project
- dotnet pack
+
+
+ cd path/to/project
+ dotnet pack
+
+
2. Dotnet pack will create a default nuget package with version of 1.0.0 in the `bin/Debug` of your project. Set an additional paket source in your build script to this directory, and require this exact version in your paket references
@@ -177,8 +201,9 @@ Tooling in netcore it not optimal yet so some things have to be done by hand, bu
* Add the info about the new module to the `dotnetAssemblyInfos` variable in `build.fsx`. From this point on the build script will let you know if anything is missing. Again, if you have problems let us know.
* Mark the old module with the `Obsolete` attribute.
-> Note that `src/Fake-netcore.sln` is currently not used (as IDEs don't support that yet). However it is used so speed up the build, `fake run build.fsx` will let you know what to do in the error message.
-
+
+
INFO
src/Fake-netcore.sln is currently not used (as IDEs don't support that yet). However it is used so speed up the build, fake run build.fsx will let you know what to do in the error message.
+
These steps will ensure:
* People using the NuGet package will get the warnings to update the new API
diff --git a/help/markdown/core-commandlineparsing.md b/help/markdown/core-commandlineparsing.md
index 628e7cec6a2..34d5a2040d1 100644
--- a/help/markdown/core-commandlineparsing.md
+++ b/help/markdown/core-commandlineparsing.md
@@ -36,7 +36,7 @@ match DocoptResult.tryGetArgument "-m" results with
| Some arg -> printfn "%s" arg
```
-A more sophisticated example can be in the fake runner: https://github.com/fsharp/FAKE/blob/64d871f5065412fe7b233025e454ccf3b89e46d7/src/app/Fake.netcore/Program.fs#L204-L259
+A more sophisticated example can be found in the fake runner: https://github.com/fsharp/FAKE/blob/64d871f5065412fe7b233025e454ccf3b89e46d7/src/app/Fake.netcore/Program.fs#L204-L259
Or the target module:
@@ -55,31 +55,33 @@ You can also take a look at the test-suite:
- We return the arguments in the user given order in the result map (difference to `docopt.fs`)
- We parse arguments starting with `-` as positional arguments. For example consider:
- ```help
- usage: prog (NAME | --foo NAME)
+```bash
+usage: prog (NAME | --foo NAME)
- options: --foo
- ```
-
- > Note that --foo has no argument because it was not specified in the options section!
+options: --foo
+```
+
+
INFO
+
Note that --foo has no argument because it was not specified in the options section!
+
- In this scenario `prog --foo 10` is parsed as `--foo` and `NAME` argument because that is the only option. However `prog --foo=10` is parsed as `NAME` argument without any `--foo` option. Usually to prefer `--foo` you should put it first in the usage string:
+In this scenario `prog --foo 10` is parsed as `--foo` and `NAME` argument because that is the only option. However `prog --foo=10` is parsed as `NAME` argument without any `--foo` option. Usually to prefer `--foo` you should put it first in the usage string:
- ```help
- usage: prog (--foo NAME | NAME)
+```bash
+usage: prog (--foo NAME | NAME)
- options: --foo
- ```
+options: --foo
+```
However, in this particular case it doesn't make any difference.
- `[]` is not inherited for all items, only for the group. To have all items optional use `[]` on every item. For example `usage: prog [go go]` means to have either two `go` or none. A single one is not allowed.
- We do not merge external "options" in the usage string with `[options]`. For example:
- ```help
- usage: prog [options] [-a]
+```bash
+usage: prog [options] [-a]
- options: -a
- -b
- ```
+options: -a
+ -b
+```
- Means that `-a` is actually allowed twice.
+Means that `-a` is actually allowed twice.
diff --git a/help/markdown/core-process.md b/help/markdown/core-process.md
index 6ec6b64d062..21e716c7a3e 100644
--- a/help/markdown/core-process.md
+++ b/help/markdown/core-process.md
@@ -1,6 +1,9 @@
# Starting processes in "FAKE - F# Make"
-**Note: This documentation is for FAKE 5! **
+
+
INFO
+
This documentation is for FAKE version 5.0 or later.
+
[API-Reference](apidocs/v5/fake-core-process.html)
diff --git a/help/markdown/core-targets.md b/help/markdown/core-targets.md
index 93738fe7706..69d7cd411c8 100644
--- a/help/markdown/core-targets.md
+++ b/help/markdown/core-targets.md
@@ -1,6 +1,9 @@
# Running targets in "FAKE - F# Make"
-**Note: This documentation is for FAKE 5. The old documentation can be found [here](legacy-core-targets.html)! **
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
[API-Reference](apidocs/v5/fake-core-target.html), [Operators](apidocs/v5/fake-core-targetoperators.html)
@@ -8,7 +11,7 @@
If you use the `Fake.Core.Target` module and call `Target.runOrDefault` or `Target.runOrList` in your build script you will have the following CLI options:
-```help
+```bash
Usage:
fake-run --list
fake-run --version
@@ -24,7 +27,10 @@ Target Module Options [target_opts]:
-p, --parallel Run parallel with the given number of tasks.
```
-> please refer to the general [FAKE 5 runner command line interface](fake-commandline.html) or the [Fake.Core.CommandLineParsing documentation](core-commandlineparsing.html) for details.
+
This means you can - for example - run `fake run build.fsx --list`
or `fake build --list` to list your targets.
@@ -33,12 +39,18 @@ To run a target `MyTarget` you could use `fake run build.fsx -t MyTarget` or `f
All parameters after `--` or `target ` are given to the target as paramters. Note that this feature needs to be enabled by using `Target.runOrDefaultWithArguments` instead of `Target.runOrDefault`!
-> Note that the ordering of the parameters matters! This means the following are invalid (which is different to pre FAKE 5 versions):
-> - `fake run -t Target build.fsx` - because of ordering fake will assume `-t` to be the script name
-> - `fake build -v` - It will not run FAKE in verbose mode but give the parameter `-v` to the target parameters. This is because there is no `-v` in the above CLI.
->
-> In general you should use the command-line in a way to not be broken when new parameters are added.
-> Use longer forms in your scripts and shorter forms on your shell!
+
+
INFO
+
Note that the ordering of the parameters matters! This means the following are invalid (which is different to pre FAKE 5 versions):
+
+
fake run -t Target build.fs - because of ordering fake will assume -t to be the script name
+
fake build -v - It will not run FAKE in verbose mode but give the parameter -v to the target parameters. This is because there is no -v in the above CLI.
+
+ In general you should use the command-line in a way to not be broken when new parameters are added.
+ Use longer forms in your scripts and shorter forms on your shell!
+
+
+
## Running specific targets
@@ -74,9 +86,16 @@ open Fake.Core.TargetOperators
Target.runOrDefault "Deploy"
```
-> Warning: Previous versions of FAKE 5 used `(fun () -> ...)` instead of `(fun _ -> ...)`.
-> We decided to change the syntax here to introduce some parameters or other features at a later point.
-> Using the current parameter object is not supported yet.
+
+
WARNING
+
+ Previous versions of FAKE 5 used (fun () -> ...) instead of (fun _ -> ...).
+ We decided to change the syntax here to introduce some parameters or other features at a later point.
+ Using the current parameter object is not supported yet.
+
+
+
+
Now we have the following options:
diff --git a/help/markdown/core-trace.md b/help/markdown/core-trace.md
index 2635a1321b4..8fda9ca0388 100644
--- a/help/markdown/core-trace.md
+++ b/help/markdown/core-trace.md
@@ -30,6 +30,7 @@ Trace.traceLine()
Target.create "mytarget" (fun _ ->
use __ = Trace.traceTask "MyOperation" "Description"
// do my operation
+ __.MarkSuccess()
)
```
diff --git a/help/markdown/dotnet-assemblyinfo.md b/help/markdown/dotnet-assemblyinfo.md
index bc4aec0d618..e3f9eeee041 100644
--- a/help/markdown/dotnet-assemblyinfo.md
+++ b/help/markdown/dotnet-assemblyinfo.md
@@ -1,6 +1,9 @@
# Generating AssemblyInfo files
-**Note: This documentation is for FAKE.exe after version 5. The documentation for previous version (<=4) can be found [here](legacy-assemblyinfo.html)! **
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
In this article the AssemblyInfo task is used in order to set specific version information to .NET assemblies.
diff --git a/help/markdown/dotnet-nuget.md b/help/markdown/dotnet-nuget.md
index f7d57603226..e28b7bf725d 100644
--- a/help/markdown/dotnet-nuget.md
+++ b/help/markdown/dotnet-nuget.md
@@ -1,6 +1,9 @@
# NuGet package restore
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
If you are using a source control system like [git](http://git-scm.com/) you probably don't want to store all binary dependencies in it.
With FAKE you can use [NuGet](http://nuget.codeplex.com/) to download all dependent packages during the build.
@@ -21,52 +24,30 @@ If you need to use different parameters please use the [RestorePackage](apidocs/
If you don't want to store FAKE.exe and its components in your repository, you can use a batch file which downloads it before the build:
- [lang=batchfile]
+
# Creating NuGet packages
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
-
## Creating a .nuspec template
The basic idea to create nuget packages is to create a .nuspec template and let FAKE fill out the missing parts.
The following code shows such .nuspec file from the [OctoKit](https://github.com/octokit/octokit.net) project.
- [lang=xml]
-
-
-
- @project@
- @build.number@
- @authors@
- @authors@
- @summary@
- https://github.com/octokit/octokit.net/blob/master/LICENSE.txt
- https://github.com/octokit/octokit.net
- https://github.com/octokit/octokit.net/icon.png
- false
- @description@
- @releaseNotes@
- Copyright GitHub 2013
- GitHub API Octokit
- @dependencies@
- @references@
-
- @files@
-
+
+
The .nuspec template contains some placeholders like `@build.number@` which can be replaced later by the build script.
It also contains some specific information like the copyright which is not handled by FAKE.
The following table gives the correspondence between the placeholders and the fields of the record type used by the NuGet task.
Placeholder | replaced by (`NuGetParams` record field)
---- | ---
+:--- | :---
`@build.number@` | `Version`
`@authors@` | `Authors`
`@project@` | `Project`
diff --git a/help/markdown/dotnet-testing-opencover.md b/help/markdown/dotnet-testing-opencover.md
index 7f49eb9d6cd..834e365220a 100644
--- a/help/markdown/dotnet-testing-opencover.md
+++ b/help/markdown/dotnet-testing-opencover.md
@@ -1,7 +1,7 @@
# Analyze your code coverage with OpenCover
From the [project](https://github.com/OpenCover/opencover):
-"A code coverage tool for .NET 2 and above (WINDOWS OS only), support for 32 and 64 processes with both branch and sequence points."
+>"A code coverage tool for .NET 2 and above (WINDOWS OS only), support for 32 and 64 processes with both branch and sequence points."
It will analyze the code coverage during testing and generates an XML report which can be used to generates HTML pages or uploaded to online services like [coveralls](https://coveralls.io/) or [codecov](https://codecov.io/).
@@ -62,4 +62,4 @@ Target.create "OpenCover" (fun _ ->
})
"MyProject.Tests.dll -noshadow"
)
-```
\ No newline at end of file
+```
diff --git a/help/markdown/fake-cache.md b/help/markdown/fake-cache.md
index 27e92ec03bc..a6f81d881c3 100644
--- a/help/markdown/fake-cache.md
+++ b/help/markdown/fake-cache.md
@@ -1,6 +1,9 @@
# Caching of build scripts
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
Starting with version `4.0.0` of FAKE, the first time a script is run the
compiled assembly that is generated is saved into the hidden `.fake` directory. This
@@ -14,4 +17,4 @@ which stops FAKE from dumping the compiled assembly to disk. Do note that the
assembly is still being compiled by FSI, all you are disabling is the saving
to disk.
-You should add the `.fake` folder to your `.gitignore` file.
\ No newline at end of file
+You should add the `.fake` folder to your `.gitignore` file.
diff --git a/help/markdown/fake-commandline.md b/help/markdown/fake-commandline.md
index 075d4bcc3eb..4e359e9f80a 100644
--- a/help/markdown/fake-commandline.md
+++ b/help/markdown/fake-commandline.md
@@ -1,36 +1,37 @@
# FAKE Command Line
-**Note: This documentation is for FAKE.exe version 5.0 or later. The old documentation can be found [here](legacy-commandline.html)**
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
-The `fake.exe` command line interface (CLI) is defined as follows:`
-
-```help
+The `fake.exe` command line interface (CLI) is defined as follows:
+```bash
Usage:
- fake.exe [fake_opts] run [run_opts] [] [--] [...]
- fake.exe [fake_opts] build [build_opts] [--] [...]
- fake.exe --version
- fake.exe --help | -h
+fake.exe [fake_opts] run [run_opts] [] [--] [...]
+fake.exe [fake_opts] build [build_opts] [--] [...]
+fake.exe --version
+fake.exe --help | -h
Fake Options [fake_opts]:
- -v, --verbose [*] Verbose (can be used multiple times)
+-v, --verbose [*] Verbose (can be used multiple times)
Is ignored if -s is used.
* -v: Log verbose but only for FAKE
* -vv: Log verbose for Paket as well
- -s, --silent Be silent, use this option if you need to pipe your output into another tool or need some additional processing.
+-s, --silent Be silent, use this option if you need to pipe your output into another tool or need some additional processing.
Fake Run Options [run_opts]:
- -d, --debug Debug the script.
- -n, --nocache Disable fake cache for this run.
- --fsiargs [*] Arguments passed to the f# interactive.
+-d, --debug Debug the script.
+-n, --nocache Disable fake cache for this run.
+--fsiargs [*] Arguments passed to the f# interactive.
Fake Build Options [build_opts]:
- -d, --debug Debug the script.
- -n, --nocache Disable fake cache for this run.
- --fsiargs [*] Arguments passed to the f# interactive.
- -f, --script
+-d, --debug Debug the script.
+-n, --nocache Disable fake cache for this run.
+--fsiargs [*] Arguments passed to the f# interactive.
+-f, --script
The script to execute (defaults to `build.fsx`).
```
-
Please refer to the [Fake.Core.CommandLineParsing documentation](core-commandlineparsing.html) for a explanation of the synax.
For now fake only supports the `run` and `build` subcommands which are basically equivalent to the Fake as you know it, but more are planned in the future. In general you should use the `run` subcommand in scripting when you use parameters, because it is safer in regards to adding options without breaking. Use `build` to have a more dense workflow in the command line
@@ -96,7 +97,7 @@ Please refer to the [target module documentation](core-targets.html)
For reference the CLI for the targets-module looks like this:
-```help
+```bash
Usage:
fake-run --list
fake-run --version
@@ -112,4 +113,4 @@ Target Module Options [target_opts]:
-p, --parallel Run parallel with the given number of tasks.
```
-Basically this means you insert the options as `` parameters at the end.
\ No newline at end of file
+Basically this means you insert the options as `` parameters at the end.
diff --git a/help/markdown/fake-debugging.md b/help/markdown/fake-debugging.md
index 42d950442c4..491e9f03f79 100644
--- a/help/markdown/fake-debugging.md
+++ b/help/markdown/fake-debugging.md
@@ -2,7 +2,11 @@
Currently debugging support (and documentation around it) is limited. Please help to improve the situation by improving the code and the docs!
-> Currently debugging via the `chocolatey` installation is not possible. This is because we currently do not distribute the x64 version on x64 versions of windows and the .NET Core debugger currently only supports x64!
+
+
WARNING
+
Currently debugging via the chocolatey installation is not possible. This is because we currently do not distribute the x64 version on x64 versions of windows and the .NET Core debugger currently only supports x64!
+
+
## General considerations
@@ -17,21 +21,24 @@ Debugging works (on windows) in the following way:
- Open Visual Studio Code
- Open "The Debugger" view and add the following configuration
- ```json
- {
- "name": "Debug My Build Script",
- "type": "coreclr",
- "request": "launch",
- "program": "E:\\fake-dotnetcore-portable\\fake.dll",
- "args": ["run", "--fsiargs", "--debug:portable --optimize-", "build.fsx"],
- "cwd": "${workspaceRoot}",
- "stopAtEntry": false,
- "console": "internalConsole"
- }
- ```
-
- > It is important to specify `--debug:portable --optimize-`
- > To get debugging support for .NET Core you need [C# for Visual Studio Code](https://github.com/OmniSharp/omnisharp-vscode)
+
It is important to specify --debug:portable --optimize
+ To get debugging support for .NET Core you need C# for Visual Studio Code
+
+
- Delete the `.fake` directory
- Set a breakpoint in your script and run the new configuration
diff --git a/help/markdown/fake-dotnet-testing-specflow.md b/help/markdown/fake-dotnet-testing-specflow.md
index cb51dea1fb3..7cc0a9b1bf8 100644
--- a/help/markdown/fake-dotnet-testing-specflow.md
+++ b/help/markdown/fake-dotnet-testing-specflow.md
@@ -1,6 +1,9 @@
# Make BDD with Gherkin and SpecFlow
-**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](apidocs/v4/fake-specflowhelper.html)**
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
Use [SpecFlow] to define, manage and automatically execute human-readable acceptance tests in .NET projects. Writing easily understandable tests is a cornerstone of the BDD paradigm and also helps build up a living documentation of your system.
@@ -47,4 +50,4 @@ Target.create "Default" Target.DoNothing
Target.runOrDefault "Default"
```
-[SpecFlow]: http://specflow.org
\ No newline at end of file
+[SpecFlow]: http://specflow.org
diff --git a/help/markdown/fake-dotnetcore.md b/help/markdown/fake-dotnetcore.md
index 35b1ab806a6..fbff70764ce 100644
--- a/help/markdown/fake-dotnetcore.md
+++ b/help/markdown/fake-dotnetcore.md
@@ -10,17 +10,21 @@ Just install the corresponding package for your system:
- Install chocolatey (a windows package manager) if you have not installed it yet (see https://chocolatey.org).
Basically open an admin `cmd.exe` and paste
- ```batch
- @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"
- ```
+
- Install fake via chocolatey
In an admin `cmd.exe` enter:
- ```ps
- choco install fake -pre
- ```
+
+
+ choco install fake -pre
+
+
- There are [other ways to get started](fake-gettingstarted.html#Install-FAKE) if chocolatey / an administrator-cmd or global installation is not an option.
@@ -31,9 +35,7 @@ Just install the corresponding package for your system:
now you can use
-```ps
-fake --help
-```
+
fake --help
This is basically it. You can now execute fake commands. Follow the [minimal example below](fake-dotnetcore.html#Minimal-example) for a quick start.
@@ -73,9 +75,7 @@ This version assumes an existing dotnet sdk installation while the non-portable
Just use the `-portable` version of the downloads, extract it and execute.
-```shell
-dotnet fake.dll
-```
+
dotnet fake.dll
The advantage of this method is that it is portable (ie. distribute the same binaries) and requires less bandwidth.
The disadvantage is that you need to have a dotnet sdk installed.
@@ -123,9 +123,9 @@ Target.runOrDefault "Deploy"
Run this file by executing
-```shell
+
fake run build.fsx
-```
+
## Downloads
@@ -135,4 +135,7 @@ Get the latest binaries from chocolatey: https://chocolatey.org/packages/fake
Get the latest dotnet-fake cli tool by adding `` to your dependencies (https://www.nuget.org/packages/dotnet-fake)
-> Note that `Version="5.*"` is working only after we released the first stable release. For now use `Version="5.0.0-*"` to get the latest non-stable release
\ No newline at end of file
+
+
INFO
+
Note that `Version="5.*"` is working only after we released the first stable release. For now use `Version="5.0.0-*"` to get the latest non-stable release
+
diff --git a/help/markdown/fake-fake5-custom-modules.md b/help/markdown/fake-fake5-custom-modules.md
index 1200ace327a..a8c2e7f3316 100644
--- a/help/markdown/fake-fake5-custom-modules.md
+++ b/help/markdown/fake-fake5-custom-modules.md
@@ -1,6 +1,9 @@
# FAKE 5 - Custom Modules
-**Note: This documentation is for FAKE.exe version 5.0 or later. The old documentation can be found [here](legacy-customtasks.html)**
+
+
INFO
+
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 therefore it should be as easy as possible to create custom tasks.
This tutorial shows how to create a (very simple) custom task in C#. The same works for other .NET language like Visual Basic or F#.
diff --git a/help/markdown/fake-fake5-modules.md b/help/markdown/fake-fake5-modules.md
index 7ba18a2d519..375c82160e2 100644
--- a/help/markdown/fake-fake5-modules.md
+++ b/help/markdown/fake-fake5-modules.md
@@ -40,15 +40,22 @@ and execute `fake run build.fsx`. This works for all FAKE 5 modules, just add ot
Please read introduction about [Paket](https://fsprojects.github.io/Paket/) for more information about the `paket.dependencies` file.
-> Note: This works because by default FAKE 5 searches for a group annotated with the `// [ FAKE GROUP ]` comment.
+
+
NOTE
+ This works because by default FAKE 5 searches for a group annotated with the // [ FAKE GROUP ] comment.
+
## Declaring FAKE 5 dependencies within the script
To be more independent from paket infrastructure (stand-alone-scripts and similar situations) there is a way to specify dependencies from within the script itself.
-> We use the new syntax specified in [FST-1027](https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1027-fsi-references.md).
-> However, to be fully compatible with existing tooling and infrastructure make sure to add `//` at the end of the `#r` string.
-> See https://github.com/fsharp/FAKE/pull/1770 for details.
+
+
INFO
+ We use the new syntax specified in FST-1027.
+ However, to be fully compatible with existing tooling and infrastructure make sure to add `//` at the end of the `#r` string.
+ See for details.
+
+
### Reference a paket group
@@ -65,8 +72,10 @@ The last line `#load` is not required by FAKE 5, however
this way the file can still be edited in editors (after restoring packages initially).
Fake will write an `intellisense.fsx` file for you importing all required references.
-> Note that in this scenario the `// [ FAKE GROUP ]` comment mentioned above is not required.
-
+
+
INFO
+ Note that in this scenario the // [ FAKE GROUP ] comment mentioned above is not required.
+
### Inline dependencies
To write your build dependencies in-line you can put the following at the top of your `build.fsx` script
@@ -89,4 +98,4 @@ You use the modules as documented in their corresponding help section.
But usually it's:
* `open Fake.` for example `open Fake.Core`
-* Using the features
\ No newline at end of file
+* Using the features
diff --git a/help/markdown/fake-gettingstarted.md b/help/markdown/fake-gettingstarted.md
index 2cb92e879f8..9ffbbdbfa20 100644
--- a/help/markdown/fake-gettingstarted.md
+++ b/help/markdown/fake-gettingstarted.md
@@ -1,6 +1,9 @@
# Getting started with FAKE - F# Make
-**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](legacy-gettingstarted.html)**
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
In this tutorial you will learn how to set up a complete build infrastructure with "FAKE - F# Make". This includes:
@@ -22,8 +25,10 @@ There are various ways to install FAKE 5
* Bootstrap via shell script (fake.cmd/fake.sh),
see this [example project](https://github.com/matthid/fake-bootstrap)
-
- > DISCLAIMER: These scripts have no versioning story. You either need to take care of versions yourself (and lock them) or your builds might break on major releases.
+
+
WARNING
+
These scripts have no versioning story. You either need to take care of versions yourself (and lock them) or your builds might break on major releases.
+
* Bootstrap via paket `clitool`, basically the same as `DotNetCliToolReference` but managed via paket. See the [`paket_clitool` branch of `fake-bootstrap`](https://github.com/matthid/fake-bootstrap/tree/paket_clitool) in particular the [build.proj](https://github.com/matthid/fake-bootstrap/blob/paket_clitool/build.proj) file.
@@ -38,20 +43,28 @@ Once `fake` is available you can start creating your script:
nuget Fake.Core.Target prerelease"
#load "./.fake/myscript.fsx/intellisense.fsx"
```
-
-> Note: `storage: none` is currently required because of a bug, but it will be added by default.
+
+
INFO
+
storage: none is currently required because of a bug, but it will be added by default.
+
Where you can add all the [fake modules](fake-fake5-modules.html) you need.
* run the script to restore your dependencies and setup the intellisense support: `fake run myscript.fsx`.
- This might take some seconds depending on your internet connection
-
- > The warning `FS0988: Main module of program is empty: nothing will happen when it is run` indicates that you have not written any code into the script yet.
+ This might take some seconds depending on your internet connection
+
+
INFO
+
The warning FS0988: Main module of program is empty: nothing will happen when it is run indicates that you have not written any code into the script yet.
+
* now open the script in VS Code with ionide-fsharp extension or Visual Studio.
-
-> Note: If you change your dependencies you need to delete `myscript.fsx.lock` and run the script again for intellisense to update.
-> Note: Intellisense is shown for the full framework while the script is run as `netcoreapp20` therefore intellisense might show APIs which are not actually usable.
+
+
INFO
+
+ If you change your dependencies you need to delete myscript.fsx.lock and run the script again for intellisense to update.
+ Intellisense is shown for the full framework while the script is run as netcoreapp20 therefore intellisense might show APIs which are not actually usable.
+
+
## Example - Compiling and building your .NET application
@@ -115,8 +128,6 @@ Now we remove the `build.fsx.lock` file and run `fake build` in order to restore
As we can now work with intellisense we can easily discover the various modules and functions in `Fake.IO`, for example the `Shell` module provides various functions you expect from regular shell scripting, but we use `Shell.CleanDir` which will ensure the given directory is empty by deleting everything within or creating the directory if required:
-> Hint: you can explore the APIs for example by writing `Fake.IO.` and waiting for intellisense (or pressing `Strg+Space`).
-> You can remove `Fake.IO` once you put `open Fake.IO` on top.
```fsharp
#r "paket:
@@ -148,6 +159,11 @@ open Fake.Core.TargetOperators
// start build
Target.runOrDefault "Default"
```
+
+
HINT
+ You can explore the APIs for example by writing Fake.IO. and waiting for intellisense (or pressing Strg+Space).
+ You can remove Fake.IO once you put open Fake.IO on top.
+
We introduced some new concepts in this snippet. At first we defined a global property called `buildDir` with the relative path of a temporary build folder.
diff --git a/help/markdown/fake-migrate-to-fake-5.md b/help/markdown/fake-migrate-to-fake-5.md
index 24108009399..7d1a242f084 100644
--- a/help/markdown/fake-migrate-to-fake-5.md
+++ b/help/markdown/fake-migrate-to-fake-5.md
@@ -45,21 +45,29 @@ Some warnings indicate how we want the new FAKE version to be used.
The most important part to know is that basically every feature/function changes its location and sometimes they were even grouped in different modules
as the old API was growing several years now and we never could do breaking changes.
-> IMPORTANT NOTE: If you feel like an API is still in the wrong place. Please let us know and open an issue.
-> We can make breaking changes as long as we are in the alpha/beta phase.
-
-> IMPORTANT NOTE: It's obvious from the NOTE above, but we are still figuring out the new API (even if I'm quite happy with its current state).
-> So things might break in the alpha phase. However this doesn't mean you should be afraid to use the new FAKE version.
-> In fact due to the modular design we hopefully can make breaking changes a lot more often, without breaking your builds!
-> So please try it out and if stuff breaks let us know :).
-> The good thing is you can always "lock" the versions of the FAKE modules until you are ready to upgrade.
+
+
NOTE
+
If you feel like an API is still in the wrong place. Please let us know and open an issue. We can make breaking changes as long as we are in the alpha/beta phase.
+
+
+
+
NOTE
+
It's obvious from the NOTE above, but we are still figuring out the new API (even if I'm quite happy with its current state).
+So things might break in the alpha phase. However this doesn't mean you should be afraid to use the new FAKE version.
+In fact due to the modular design we hopefully can make breaking changes a lot more often, without breaking your builds!
+So please try it out and if stuff breaks let us know :).
+The good thing is you can always "lock" the versions of the FAKE modules until you are ready to upgrade.
+
In this new work you should write "Module.Method a b" instead of "MethodModule a b". Which means in the old world we had lots of methods like
"ReadFile argument" (the module probably even opened via `[]`), which is considered bad style now.
In the new world we would open the `Fake.IO.FileSystem` namespace to indicate that we are using the file-system.
At the same time we would write `File.Read argument`, which is only a bit longer but now the IDE can help you a lot better and the code looks a lot more ideomatic and clean.
-> If you still find places where we use the "bad" style in the new API, let us know (open an issue).
+
+
NOTE
+
If you still find places where we use the "bad" style in the new API, let us know (open an issue).
+
The "open Fake" and AutoOpen modules are completely obsolete.
We urge you to finish your API-Migration (after fixing all warnings) by removing "open Fake".
diff --git a/help/markdown/fake-tools-pickles.md b/help/markdown/fake-tools-pickles.md
index 8abae1c3e32..81967e898e8 100644
--- a/help/markdown/fake-tools-pickles.md
+++ b/help/markdown/fake-tools-pickles.md
@@ -1,6 +1,9 @@
# Convert Gherkin to HTML with Pickles
-**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](apidocs/v4/fake-pickleshelper.html)**
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
[Pickles] is a Living Documentation generator: it takes your Specification (written in Gherkin, with Markdown descriptions) and turns them into an always up-to-date documentation of the current state of your software - in a variety of formats.
@@ -33,4 +36,4 @@ Target.create "BuildDoc" (fun _ ->
Target.runOrDefault "BuildDoc"
```
-[Pickles]: http://www.picklesdoc.com/
\ No newline at end of file
+[Pickles]: http://www.picklesdoc.com/
diff --git a/help/markdown/legacy-assemblyinfo.md b/help/markdown/legacy-assemblyinfo.md
index ae0f559f76d..44c75a8b103 100644
--- a/help/markdown/legacy-assemblyinfo.md
+++ b/help/markdown/legacy-assemblyinfo.md
@@ -1,6 +1,9 @@
# Generating AssemblyInfo files
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation for FAKE 5 can be found [here](dotnet-assemblyinfo.html)! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation for FAKE 5 can be found here
+
In this article the AssemblyInfo task is used in order to set specific version information to .NET assemblies.
diff --git a/help/markdown/legacy-commandline.md b/help/markdown/legacy-commandline.md
index 1d0fe8eb389..bc4e89325ef 100644
--- a/help/markdown/legacy-commandline.md
+++ b/help/markdown/legacy-commandline.md
@@ -1,8 +1,9 @@
# FAKE Command Line
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The new documentation can be found [here](fake-commandline.html)**
-
-**Note: This documentation is for FAKE.exe version 2.18 or later.**
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation for FAKE 5 can be found here
+
The FAKE.exe command line interface (CLI) is defined as follows:
diff --git a/help/markdown/legacy-core-targets.md b/help/markdown/legacy-core-targets.md
index 2ce88cc7112..82a6fef4d47 100644
--- a/help/markdown/legacy-core-targets.md
+++ b/help/markdown/legacy-core-targets.md
@@ -1,6 +1,9 @@
# Running targets in "FAKE - F# Make"
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The new documentation can be [found here](core-targets.html) **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation for FAKE 5 can be found here
+
## Listing targets
Before running any specific target it is useful to know all the targets that are available in a build script.
@@ -163,8 +166,6 @@ This is in addition to that that MSBuild may use multiple threads when building
# 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.
This tutorial shows how to create a (very simple) custom task in C#.
diff --git a/help/markdown/legacy-customtasks.md b/help/markdown/legacy-customtasks.md
index 8ca65adf25b..096fc327292 100644
--- a/help/markdown/legacy-customtasks.md
+++ b/help/markdown/legacy-customtasks.md
@@ -1,6 +1,9 @@
# Writing custom C# tasks for FAKE
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The new documentation can be found [here](fake-fake5-custom-modules.html)**
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation for FAKE 5 can be found here
+
"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#.
diff --git a/help/markdown/legacy-gettingstarted.md b/help/markdown/legacy-gettingstarted.md
index 27f26bbe339..9d91a6c5f22 100644
--- a/help/markdown/legacy-gettingstarted.md
+++ b/help/markdown/legacy-gettingstarted.md
@@ -1,6 +1,9 @@
# Getting started with FAKE - F# Make
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The new documentation can be found [here](fake-gettingstarted.html)**
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation for FAKE 5 can be found here
+
In this tutorial you will learn how to set up a complete build infrastructure with "FAKE - F# Make". This includes:
diff --git a/help/markdown/legacy-index.md b/help/markdown/legacy-index.md
index f63ce45215a..79ef1ad863b 100644
--- a/help/markdown/legacy-index.md
+++ b/help/markdown/legacy-index.md
@@ -1,6 +1,9 @@
# FAKE - F# Make - A DSL for build tasks
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
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 a build automation system with capabilities which are similar to **make** and **rake**.
It is using an easy domain-specific language (DSL) so that you can start using it without learning F#.
diff --git a/help/markdown/legacy-teamcity.md b/help/markdown/legacy-teamcity.md
index 89325213571..626d5b73ae0 100644
--- a/help/markdown/legacy-teamcity.md
+++ b/help/markdown/legacy-teamcity.md
@@ -1,6 +1,9 @@
# Integrating a FAKE build script into TeamCity
-**Note: This documentation is for FAKE before version 5 (or the non-netcore version). The new documentation can be found [here](buildserver.html)**
+
+
INFO
+
This documentation is for FAKE before version 5 (or the non-netcore version). The new documentation can be found here
+
Easy [TeamCity](http://www.jetbrains.com/teamcity/) integration was one of the major goals for the FAKE build system.
diff --git a/help/markdown/sql-dacpac.md b/help/markdown/sql-dacpac.md
index d071deef15d..a9140f86bfb 100644
--- a/help/markdown/sql-dacpac.md
+++ b/help/markdown/sql-dacpac.md
@@ -1,6 +1,9 @@
# Packaging and Deploying SQL Databases
-**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](legacy-dacpac.html)**
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
FAKE can be used to create a SQL DACPAC and also deploy it to a SQL Server using the MSDeploy executable. This is installed by default with Visual Studio and with the SQL Server Data Tools (SSDT) package.
@@ -28,4 +31,4 @@ You can optionally specify the type of command to use (again, refer to the docum
* Script - SQL script
* Report - XML report of diff
-In addition, you can also elect to deploy to Dacpac files rather than SQL databases - simply pass in the pass to the dacpac that you wish to generate.
\ No newline at end of file
+In addition, you can also elect to deploy to Dacpac files rather than SQL databases - simply pass in the pass to the dacpac that you wish to generate.
diff --git a/help/markdown/testing-reportgenerator.md b/help/markdown/testing-reportgenerator.md
index 4b6ba32c9ae..653292d7803 100644
--- a/help/markdown/testing-reportgenerator.md
+++ b/help/markdown/testing-reportgenerator.md
@@ -1,6 +1,10 @@
# Fake.Testing.ReportGenerator
-**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](apidocs/v4/fake-specflowhelper.html)**
+
+
INFO
+
This documentation is for FAKE version 5.0 or later. The old documentation can be found here
+
+
ReportGenerator converts XML reports generated by OpenCover, PartCover, dotCover, Visual Studio, NCover or Cobertura into human readable reports in various formats.
diff --git a/help/markdown/testing-sonarqube.md b/help/markdown/testing-sonarqube.md
index 5f91d928086..bb74d038233 100644
--- a/help/markdown/testing-sonarqube.md
+++ b/help/markdown/testing-sonarqube.md
@@ -1,7 +1,7 @@
# Analyze your code with SonarQube
From the [web page](http://sonarqube.org):
-"The SonarQube® platform is an open source quality management platform, dedicated to continuously analyzing and measuring the technical quality of source code, from project portfolio down to the method level"
+>"The SonarQube® platform is an open source quality management platform, dedicated to continuously analyzing and measuring the technical quality of source code, >from project portfolio down to the method level"
It can analyze a lot of different programming languages, from PHP, Erlang, CSS to Cobol. C# can be installed
with an additional plugin. This must be done on the SonarQube server.
diff --git a/help/markdown/todo-androidpublisher.md b/help/markdown/todo-androidpublisher.md
index 71f80d10859..c1d224e8ef1 100644
--- a/help/markdown/todo-androidpublisher.md
+++ b/help/markdown/todo-androidpublisher.md
@@ -1,6 +1,9 @@
# Publish Android apk
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
This module helps android developers to automatically publish their APKs
diff --git a/help/markdown/todo-deploy.md b/help/markdown/todo-deploy.md
index c3469380a7e..0eebd05f1f7 100644
--- a/help/markdown/todo-deploy.md
+++ b/help/markdown/todo-deploy.md
@@ -1,12 +1,13 @@
# Deployment using FAKE
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
Fake.Deploy is no longer part of FAKE 5 and is considered obsolete and fully replaced by modern deployment systems (puppet, chef, PowerShell DSC, ...). Announcement
+ You can still use fake scripts on those alternative deployment systems. Just download the fake binaries and run your scripts.
+
This introduction assumes Fake.Deploy.exe is available in the current directory or path.
-**Note: Fake.Deploy is no longer part of FAKE 5 and is considered obsolete and fully replaced by modern deployment systems (puppet, chef, PowerShell DSC, ...). [Announcement](https://github.com/fsharp/FAKE/issues/1820)
-**Tipp: You can still use fake scripts on those alternative deployment systems. Just download the fake binaries and run your scripts.
-
## Introduction
The FAKE deployment tool allows users to deploy applications to remote computers and to run scripts on these remote agents. A typical scenario maybe as follows:
@@ -151,4 +152,4 @@ Then save the public key, you need to put this into Fake.Deploy's authorized key
To save the private key, click `Conversions` menu option and then click `Export OpenSSH key`
### Linux
- ssh-keygen -t rsa -b 2048 -N password
\ No newline at end of file
+ ssh-keygen -t rsa -b 2048 -N password
diff --git a/help/markdown/todo-fluentmigrator.md b/help/markdown/todo-fluentmigrator.md
index 2958945298b..2cd47be77bd 100644
--- a/help/markdown/todo-fluentmigrator.md
+++ b/help/markdown/todo-fluentmigrator.md
@@ -1,6 +1,9 @@
# Running database migrations with FluentMigrator
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
[FluentMigrator](https://github.com/schambers/fluentmigrator/) is a .NET library which helps to version database schema using incremental migrations which are described in C#.
The basic idea of the FAKE helper is to run FluentMigrator over the existing database using compiled assembly with migrations.
diff --git a/help/markdown/todo-fsc.md b/help/markdown/todo-fsc.md
index 8e7d7da2e4f..f114103352b 100644
--- a/help/markdown/todo-fsc.md
+++ b/help/markdown/todo-fsc.md
@@ -1,6 +1,9 @@
# Compiling F# Sources
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
The [Fsc task set](apidocs/v5/legacy/fake-fschelper.html) in FAKE can be used to build F# source files and output libraries, modules,
and executables by using the bundled
diff --git a/help/markdown/todo-fxcop.md b/help/markdown/todo-fxcop.md
index f7c0947a4c2..6e615cf2920 100644
--- a/help/markdown/todo-fxcop.md
+++ b/help/markdown/todo-fxcop.md
@@ -1,6 +1,9 @@
# Adding FxCop to a FAKE build script
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
This article is an extension to the [getting started guide](gettingstarted.html). You will improve the same Calculator sample with a task for [FxCop](http://msdn2.microsoft.com/en-us/library/bb429476.aspx).
diff --git a/help/markdown/todo-octopusdeploy.md b/help/markdown/todo-octopusdeploy.md
index f8e189f3cc7..cc70bde2456 100644
--- a/help/markdown/todo-octopusdeploy.md
+++ b/help/markdown/todo-octopusdeploy.md
@@ -1,6 +1,9 @@
# Automating Deployment using FAKE and Octopus Deploy
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
[Octopus Deploy](http://octopusdeploy.com/) is a great tool for simple and user-friendly release management.
diff --git a/help/markdown/todo-typescript.md b/help/markdown/todo-typescript.md
index b0c1f25d864..d4e1f713044 100644
--- a/help/markdown/todo-typescript.md
+++ b/help/markdown/todo-typescript.md
@@ -1,6 +1,9 @@
# Compiling TypeScript applications
-**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
+
+
INFO
+
This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help!
+
FAKE can be used to build a variety of different application types.
In this tutorial we are looking at the TypeScript support.
diff --git a/help/markdown/windows-chocolatey.md b/help/markdown/windows-chocolatey.md
index 4d0e15efd52..56315aef6bc 100644
--- a/help/markdown/windows-chocolatey.md
+++ b/help/markdown/windows-chocolatey.md
@@ -58,7 +58,7 @@ Target.create "ChocoPack" (fun _ ->
It adds Chocolatey specific fields:
Placeholder | replaced by (`ChocoPackParams` record field)
---- | ---
+:--- | :---
`@docsUrl@` | `DocsUrl`: Url pointing to the location of the wiki or docs of the software.
`@mailingListUrl@` | `MailingListUrl`: Url pointing to the forum or email list group for the software.
`@bugTrackerUrl@` | `BugTrackerUrl`: Url pointing to the location where issues and tickets can be accessed.
@@ -70,7 +70,7 @@ To use a chocolateyInstall.ps1 template, a file with the same name must exists i
If it doesn't exists but at least `Title` and `PackageDownloadUrl` are defined, the chocolateyInstall.ps1 will be created
Placeholder | replaced by (`ChocoPackParams` record field)
---- | ---
+:--- | :---
`@packageName@` | `Title`: Title of the package.
`@url@` | `PackageDownloadUrl`: Url pointing to the installer (exe, msi, zip) of the package.
`@url64@` | `PackageDownload64Url`: Url pointing to the installer (exe, msi, zip) of the 64 bits version of the package.
@@ -87,7 +87,7 @@ To use a chocolateyUninstall.ps1 template, a file with the same name must exists
If it doesn't exists but at least `Title` and `UninstallPath` are defined, the chocolateyUninstall.ps1 will be created
Placeholder | replaced by (`ChocoPackParams` record field)
---- | ---
+:--- | :---
`@packageName@` | `Title`: Title of the package.
`@silentArgs@` | `SilentArgs`: Silent args for the installer.
`@installerType@` | `InstallerType`: Installer type. Default: Zip.
diff --git a/help/templates/fake5/apidocstemplate.cshtml b/help/templates/fake5/apidocstemplate.cshtml
index 89fb721f3cd..f51c47f14db 100644
--- a/help/templates/fake5/apidocstemplate.cshtml
+++ b/help/templates/fake5/apidocstemplate.cshtml
@@ -10,14 +10,20 @@
-
- Note: This API documentation is for FAKE version 5.0 or later. The old API documentation can be found
- here for migration or here for fake 4
-
-
}
-}
\ No newline at end of file
+}
diff --git a/help/templates/reference/type.cshtml b/help/templates/reference/type.cshtml
index 882c81e5e9f..e1957d242b2 100644
--- a/help/templates/reference/type.cshtml
+++ b/help/templates/reference/type.cshtml
@@ -10,7 +10,7 @@
// Get all the members & comment for the type
var members = (IEnumerable)Model.Type.AllMembers;
var comment = (Comment)Model.Type.Comment;
-
+ var type = (FSharp.MetadataFormat.Type)Model.Type;
// Group all members by their category which is an inline annotation
// that can be added to members using special XML comment:
//
@@ -28,7 +28,16 @@
Name = String.IsNullOrEmpty(g.Key) ? "Other type members" : g.Key
});
}
+