Skip to content

Commit

Permalink
Merge branch 'release/next' of github.com:fsharp/FAKE into release/next
Browse files Browse the repository at this point in the history
  • Loading branch information
matthid committed Dec 3, 2018
2 parents 38042aa + 6bbc98b commit 4aef888
Show file tree
Hide file tree
Showing 49 changed files with 396 additions and 339 deletions.
14 changes: 7 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ If available, link to an existing issue this PR fixes. For example:

Feel free to open the PR and ask for help

- [] New (API-)documentation for new features exist (Note: API-docs are enough, additional docs are in `help/markdown`)
- [] unit or integration test exists (or short reasoning why it doesn't make sense)
- [ ] New (API-)documentation for new features exist (Note: API-docs are enough, additional docs are in `help/markdown`)
- [ ] unit or integration test exists (or short reasoning why it doesn't make sense)

> Note: Consider using the `CreateProcess` API which can be tested more easily, see https://github.com/fsharp/FAKE/pull/2131/files#diff-4fb4a77e110fbbe8210205dfe022389b for an example (the changes in the `DotNet.Testing.NUnit` module)
- [] boy scout rule: "leave the code behind in a better state than you found it" (fix warnings, obsolete members or code-style in the places you worked in)
- [] (if new module) the module has been linked from the "Modules" menu, edit `help/templates/template.cshtml`, linking to the API-reference is fine.
- [] (if new module) the module is in the correct namespace
- [] (if new module) the module is added to Fake.sln (`dotnet sln Fake.sln add src/app/Fake.*/Fake.*.fsproj`)
- [] Fake 5 [API guideline](https://fake.build/contributing.html#API-Design) is honored
- [ ] boy scout rule: "leave the code behind in a better state than you found it" (fix warnings, obsolete members or code-style in the places you worked in)
- [ ] (if new module) the module has been linked from the "Modules" menu, edit `help/templates/template.cshtml`, linking to the API-reference is fine.
- [ ] (if new module) the module is in the correct namespace
- [ ] (if new module) the module is added to Fake.sln (`dotnet sln Fake.sln add src/app/Fake.*/Fake.*.fsproj`)
- [ ] Fake 5 [API guideline](https://fake.build/contributing.html#API-Design) is honored
9 changes: 8 additions & 1 deletion help/content/assets/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,14 @@ section.is-small {

.content .anchor {
text-decoration: none;
padding-top: 70px;
}

.content .anchor::before {
content: "";
display: block;
height: 50px;
margin: -50px 0 0;
visibility: hidden;
}

@media screen and (max-width: 768px) {
Expand Down
19 changes: 18 additions & 1 deletion help/markdown/core-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,29 @@ Or a properly escaped command line:

```fsharp
CreateProcess.fromRawWindowsCommandLine "./folder/mytool.exe" "arg1 arg2 arg3"
CreateProcess.fromRawCommandLine "./folder/mytool.exe" "arg1 arg2 arg3"
|> Proc.run // start with the above configuration
|> ignore // ignore exit code
```

Or use helper libraries like [`BlackFox.CommandLine`](https://github.com/vbfox/FoxSharp/tree/master/src/BlackFox.CommandLine):

```fsharp
open BlackFox.CommandLine
CmdLine.empty
|> CmdLine.append "build"
|> CmdLine.appendIf noRestore "--no-restore"
|> CmdLine.appendPrefixIfSome "--framework" framework
|> CmdLine.appendPrefixf "--configuration" "%A" configuration
|> CmdLine.toString
|> CreateProcess.fromRawCommandLine "dotnet.exe"
|> Proc.run
|> ignore
```

## Evaluate exit code

The most obvious way is:
Expand Down
5 changes: 2 additions & 3 deletions help/markdown/fake-dotnetcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Just install the corresponding package for your system:

- Windows (chocolatey)

- Install chocolatey (a windows package manager) if you have not installed it yet (see https://chocolatey.org).
- Install chocolatey (a windows package manager) if you have not installed it yet (see [https://chocolatey.org](https://chocolatey.org)).
Basically open an admin `cmd.exe` and paste

<pre>
Expand Down Expand Up @@ -181,5 +181,4 @@ Get the latest packages from GitHub: https://github.com/fsharp/FAKE/releases

Get the latest binaries from chocolatey: https://chocolatey.org/packages/fake

Get the latest dotnet-fake cli tool by adding `<DotNetCliToolReference Include="dotnet-fake" Version="5.*" />` to your dependencies (https://www.nuget.org/packages/dotnet-fake)

Get the latest dotnet-fake cli tool by adding `<DotNetCliToolReference Include="dotnet-fake" Version="5.*" />` to your dependencies: https://www.nuget.org/packages/dotnet-fake
2 changes: 1 addition & 1 deletion help/markdown/fake-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ After you installed the template you can setup FAKE by running:
<pre><code class="lang-bash">
dotnet new fake
</code></pre>
This will create a default `build.fsx` file, a `paket.dependencies` file used to mangage your build dependencies and two shell scripts `fake.sh` and `fake.cmd`. The shell scripts are used to bootstrap and run FAKE. All of the arguments are passed direcly to FAKE so you can run:
This will create a default `build.fsx` file, a `paket.dependencies` file used to mangage your build dependencies and two shell scripts `fake.sh` and `fake.cmd`. The shell scripts are used to bootstrap and run FAKE. All of the arguments are passed directly to FAKE so you can run:
<pre><code class="lang-bash">
.\fake.cmd build
</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion help/templates/template.cshtml
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@
<ul class="has-text-grey-light">
<li><a href="/fake-gettingstarted.html">Getting started</a></li>
<li><a href="/fake-fake5-modules.html">Modules</a></li>
<li><a href="/fake-fake5-modules.html#Declaring-FAKE-5-Header">FAKE Header</a></li>
<li><a href="/fake-fake5-modules.html#Declaring-FAKE-5-dependencies-within-the-script">FAKE Header</a></li>
</ul>
</div>
<div class="column is-6">
Expand Down
Loading

0 comments on commit 4aef888

Please sign in to comment.