-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4331941
commit 83f4957
Showing
2 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
Order: 1 | ||
--- | ||
|
||
# Build scripts | ||
|
||
To build this package we are using Cake. | ||
|
||
On Windows PowerShell run: | ||
|
||
```powershell | ||
./build | ||
``` | ||
|
||
On OSX/Linux run: | ||
|
||
```bash | ||
./build.sh | ||
``` | ||
|
||
# Important developer tasks | ||
|
||
## Default task | ||
|
||
Clean, DotNetCore build, unit tests, code coverage, code analyze, NuGet package, create release notes. | ||
|
||
```powershell | ||
./build | ||
``` | ||
```powershell | ||
./build -Target Default | ||
``` | ||
|
||
## AppVeyor task | ||
|
||
The same as Default and: | ||
Publish documentation, upload code coverage, publish release note, publish NuGet, upload build artifacts. | ||
|
||
```powershell | ||
./build -Target Appveyor | ||
``` | ||
|
||
## Preview task | ||
|
||
```powershell | ||
./build -Target Preview | ||
``` | ||
|
||
Generate documentation and host documentation locally for development. | ||
More about [Preview](https://cake-contrib.github.io/Cake.Recipe/docs/usage/previewing-documentation) | ||
and [Docs publishing](https://cake-contrib.github.io/Cake.Recipe/docs/usage/publishing-documentation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
Order: 2 | ||
--- | ||
|
||
# Running integration tests | ||
|
||
Addin contains set of integration tests written as additional Cake files. | ||
**test.cake** - is an entry point for integration tests. Installs Cake.MkDocs nuget package from BuildArtifacts directory and use him in all tests. | ||
**setup.cake** - his responsibility is launch integration tests in sandbox. | ||
|
||
## Run-Integration-Tests task | ||
|
||
```powershell | ||
./build -Target Run-Integration-Tests | ||
``` | ||
|
||
Task first of all execute *Default* target to build all artifacts. | ||
After all use BuildArtifacts and runs integration tests (**test.cake**). | ||
|
||
## Run-Integration-Tests-Standalone task | ||
|
||
```powershell | ||
./build -Target Run-Integration-Tests-Standalone | ||
``` | ||
|
||
Task use BuildArtifacts and runs integration tests without build - use for integration tests development. | ||
This task is also run additionally after target task, when target is different than *Run-Integration-Tests* (e.g. *Default*, *Appveyor*) and BuildParameters.ShouldRunIntegrationTests flag is true. |