Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fsprojects/FAKE
FAKE - F# Make
https://github.com/fsprojects/FAKE
Last synced: about 1 month ago
JSON representation
FAKE - F# Make
- Host: GitHub
- URL: https://github.com/fsprojects/FAKE
- Owner: fsprojects
- License: other
- Created: 2010-02-08T10:02:28.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T14:26:54.000Z (5 months ago)
- Last Synced: 2024-01-27T13:23:52.968Z (4 months ago)
- Language: F#
- Homepage: https://fake.build
- Size: 274 MB
- Stars: 1,268
- Watchers: 51
- Forks: 593
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: License.txt
Lists
- awesome-dotnet - FAKE - F# Make, a cross-platform build automation system (Build Automation)
- awesome-stars - fsprojects/FAKE - FAKE - F# Make (F# #)
- awesome-fsharp - FAKE
- awesome-make - Fake
README
# FAKE - F# Make · [](https://github.com/fsprojects/FAKE/actions/workflows/build_and_test.yml) [](https://www.nuget.org/packages/Fake-Cli) []([https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request](https://fake.build/guide/contributing.html)) [](https://gitter.im/fsharp/FAKE?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
"FAKE - F# Make" is a cross platform build automation system. Due to its integration
in F#, all the benefits of the .NET Framework and functional programming can be used, including
the extensive class library, powerful debuggers and integrated development environments like
Visual Studio or MonoDevelop, which provide syntax highlighting and code completion.
The new DSL was designed to be succinct, typed, declarative, extensible and easy to use.
Here is an example to get a glimpse on FAKE:
```F#
// build.fsx
#r "paket:
nuget Fake.Core.Trace
nuget Fake.Core.Target //"
// include Fake modules, see Fake modules section
open Fake.Core
// *** Define Targets ***
Target.create "Clean" (fun _ ->
Trace.log " --- Cleaning stuff --- "
)
Target.create "Build" (fun _ ->
Trace.log " --- Building the app --- "
)
Target.create "Deploy" (fun _ ->
Trace.log " --- Deploying app --- "
)
open Fake.Core.TargetOperators
// *** Define Dependencies ***
"Clean"
==> "Build"
==> "Deploy"
// *** Start Build ***
Target.runOrDefault "Deploy"
```
This example pulls Fake's `Target` and `Trace` modules and define three targets: `Clean`, `Build`, and `Deploy`. By analogy with a .Net project;
* the `Clean` target can be used to clean the project before a build,
* the `Build` target to call MSBuild or any build steps that are required for you application,
* the `Deploy` target can push your built project to a cloud service.
At the bottom, the example define target dependencies, which specify that a `Deploy` must run after a `Build` which must run after a `Clean`.
**See the [project home page](https://fake.build/) for tutorials and the [API documentation](https://fake.build/reference/index.html) for various FAKE modules.**
## Requirements
Fake runner requires .Net v6 SDK to be installed on the machine to run it. .Net v6 was chosen since it is the current LTS release of .Net
> FAKE 5 doesn't have this requirement. You can use FAKE 5 runner without having .NET 6 SDK installed since it will default to NETSTANDARD2.0 assemblies. But we advice to see the options available to run your build script in [Different Ways to run FAKE](https://fake.build/guide/getting-started.html#Different-ways-to-run-FAKE)
Fake modules has target frameworks of `net6` and `netstandard2.0`. Please [see this link](https://docs.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0) which lists the supported .Net and .NET Framework versions by `netstandard2.0`
## Installation
* Either: Download and install the [Dotnet SDK](https://www.microsoft.com/net/learn/get-started) and run `dotnet tool restore` followed by `dotnet fake build`
* Or: Install FAKE 5 or later (for example via `choco install fake -pre`) and run `fake build`
> Note: You can find more details on the [contributing page](https://fake.build/guide/contributing.html)
Make sure to have long path enabled: [see how to enable long paths](https://superuser.com/questions/1119883/windows-10-enable-ntfs-long-paths-policy-option-missing)
Otherwise the test-suite will fail (However, the compilation should work)
## Usage
See detailed instructions on how to use FAKE in the [getting started guide](https://fake.build/guide/getting-started.html).
## NuGet Packages
| Package Name | Nuget |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Fake-Cli` | [](https://www.nuget.org/packages/Fake-Cli) |
| `Fake.Core.Target` | [](https://www.nuget.org/packages/Fake.Core.Target) |
| `Fake.Core.Context` | [](https://www.nuget.org/packages/Fake.Core.Context) |
| Legacy FAKE | [](https://www.nuget.org/packages/FAKE) |
## Contributing
See the [contributing page](https://fake.build/guide/contributing.html).
## Maintainers
Although this project is hosted in the [fsprojects](https://github.com/fsprojects) organization, it is _not_ maintained and managed by the F# Core Engineering Group. The F# Core Engineering Group acknowledges that the independent owner and maintainer of this project is [Steffen Forkmann](https://github.com/forki).