Skip to content

Commit 663b08e

Browse files
authored
Split instruction how to build souce code and run website (#1234)
1 parent 690af08 commit 663b08e

File tree

3 files changed

+42
-39
lines changed

3 files changed

+42
-39
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: How to build addins
3+
description: Instructions how to build individual Cake Issues addins.
4+
---
5+
6+
Ensure the following prerequisites are fulfilled:
7+
8+
* Latest .NET version installed
9+
10+
To build the addins and run unit tests [Cake]{target="_blank"} is used:
11+
12+
=== ":material-microsoft-windows: Windows"
13+
14+
```powershell
15+
.\build.ps1
16+
```
17+
18+
=== ":material-apple: macOS"
19+
20+
```bash
21+
./build.sh
22+
```
23+
24+
=== ":material-linux: Linux"
25+
26+
```bash
27+
./build.sh
28+
```
29+
30+
To run only part of the build a task can be passed using the `--target=<TASK>` syntax:
31+
32+
| Task | Description |
33+
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
34+
| `DotNetCore-Build` | Builds all addins |
35+
| `Create-NuGet-Packages` | Builds and creates NuGet packages for all addins. The NuGet packages are available in the `BuildArtifacts\Packages\NuGet` directory. |
36+
| `Test` | Builds all addins and runs unit tests. Coverage report is available in the `BuildArtifacts\TestCoverage` directory. |
37+
38+
[Cake]: https://cakebuild.net/

docs/input/documentation/contributing/how-to-build.md renamed to docs/input/documentation/contributing/how-to-run-website.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,8 @@
11
---
2-
title: How to build addins
3-
description: Instructions how to build individual Cake Issues addins.
2+
title: How to build and run website
3+
description: Instructions how to build and run website locally
44
---
55

6-
## Building addins
7-
8-
Ensure the following prerequisites are fulfilled:
9-
10-
* Latest .NET version installed
11-
12-
To build the addins and run unit tests [Cake]{target="_blank"} is used:
13-
14-
=== ":material-microsoft-windows: Windows"
15-
16-
```powershell
17-
.\build.ps1
18-
```
19-
20-
=== ":material-apple: macOS"
21-
22-
```bash
23-
./build.sh
24-
```
25-
26-
=== ":material-linux: Linux"
27-
28-
```bash
29-
./build.sh
30-
```
31-
32-
To run only part of the build a task can be passed using the `--target=<TASK>` syntax:
33-
34-
| Task | Description |
35-
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
36-
| `DotNetCore-Build` | Builds all addins |
37-
| `Create-NuGet-Packages` | Builds an creates NuGet packages for all addins. The NuGet packages are available in the `BuildArtifacts\Packages\NuGet` directory. |
38-
| `Test` | Builds all addins and runs unit tests. Coverage report is available in the `BuildArtifacts\TestCoverage` directory. |
39-
40-
## Building and running website locally
41-
426
=== "Running in GitHub Codespaces"
437

448
Website can be built and run in [GitHub Codespaces]{target="_blank"}.

docs/mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,8 @@ nav:
325325
- Contributing:
326326
- How To Contribute: documentation/contributing/how-to-contribute.md
327327
- Open issues: https://github.com/cake-contrib/Cake.Issues/issues" target="_blank
328-
- Building Source Code: documentation/contributing/how-to-build.md
328+
- Building addins: documentation/contributing/how-to-build-addins.md
329+
- Running website: documentation/contributing/how-to-run-website.md
329330
- Maintainer Guide:
330331
- Performing Release: documentation/contributing/how-to-release.md
331332
- Resources:

0 commit comments

Comments
 (0)