Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/input/documentation/contributing/how-to-build-addins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: How to build addins
description: Instructions how to build individual Cake Issues addins.
---

Ensure the following prerequisites are fulfilled:

* Latest .NET version installed

To build the addins and run unit tests [Cake]{target="_blank"} is used:

=== ":material-microsoft-windows: Windows"

```powershell
.\build.ps1
```

=== ":material-apple: macOS"

```bash
./build.sh
```

=== ":material-linux: Linux"

```bash
./build.sh
```

To run only part of the build a task can be passed using the `--target=<TASK>` syntax:

| Task | Description |
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `DotNetCore-Build` | Builds all addins |
| `Create-NuGet-Packages` | Builds and creates NuGet packages for all addins. The NuGet packages are available in the `BuildArtifacts\Packages\NuGet` directory. |
| `Test` | Builds all addins and runs unit tests. Coverage report is available in the `BuildArtifacts\TestCoverage` directory. |

[Cake]: https://cakebuild.net/
Original file line number Diff line number Diff line change
@@ -1,44 +1,8 @@
---
title: How to build addins
description: Instructions how to build individual Cake Issues addins.
title: How to build and run website
description: Instructions how to build and run website locally
---

## Building addins

Ensure the following prerequisites are fulfilled:

* Latest .NET version installed

To build the addins and run unit tests [Cake]{target="_blank"} is used:

=== ":material-microsoft-windows: Windows"

```powershell
.\build.ps1
```

=== ":material-apple: macOS"

```bash
./build.sh
```

=== ":material-linux: Linux"

```bash
./build.sh
```

To run only part of the build a task can be passed using the `--target=<TASK>` syntax:

| Task | Description |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `DotNetCore-Build` | Builds all addins |
| `Create-NuGet-Packages` | Builds an creates NuGet packages for all addins. The NuGet packages are available in the `BuildArtifacts\Packages\NuGet` directory. |
| `Test` | Builds all addins and runs unit tests. Coverage report is available in the `BuildArtifacts\TestCoverage` directory. |

## Building and running website locally

=== "Running in GitHub Codespaces"

Website can be built and run in [GitHub Codespaces]{target="_blank"}.
Expand Down
3 changes: 2 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,8 @@ nav:
- Contributing:
- How To Contribute: documentation/contributing/how-to-contribute.md
- Open issues: https://github.com/cake-contrib/Cake.Issues/issues" target="_blank
- Building Source Code: documentation/contributing/how-to-build.md
- Building addins: documentation/contributing/how-to-build-addins.md
- Running website: documentation/contributing/how-to-run-website.md
- Maintainer Guide:
- Performing Release: documentation/contributing/how-to-release.md
- Resources:
Expand Down