Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@SimonCropp
SimonCropp committed Aug 27, 2023
1 parent e995704 commit 57b9af1
Show file tree
Hide file tree
Showing 259 changed files with 1,806 additions and 1,806 deletions.
8 changes: 4 additions & 4 deletions docs/build-server.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To change this file edit the source file and then run MarkdownSnippets.

### AppVeyor

Use a [on_failure build step](https://www.appveyor.com/docs/build-configuration/#build-pipeline) to call [Push-AppveyorArtifact](https://www.appveyor.com/docs/build-worker-api/#push-artifact).<!-- include: build-server-appveyor. path: /docs/mdsource/build-server-appveyor.include.md -->
Use a [on_failure build step](https://www.appveyor.com/docs/build-configuration/#build-pipeline) to call [Push-AppveyorArtifact](https://www.appveyor.com/docs/build-worker-api/#push-artifact). <!-- include: build-server-appveyor. path: /docs/mdsource/build-server-appveyor.include.md -->

<!-- snippet: AppVeyorArtifacts -->
<a id='snippet-appveyorartifacts'></a>
Expand All @@ -24,12 +24,12 @@ on_failure:
<sup><a href='/src/appveyor.yml#L35-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-appveyorartifacts' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->
See also [Pushing artifacts from scripts](https://www.appveyor.com/docs/packaging-artifacts/#pushing-artifacts-from-scripts).<!-- endInclude -->
See also [Pushing artifacts from scripts](https://www.appveyor.com/docs/packaging-artifacts/#pushing-artifacts-from-scripts). <!-- endInclude -->
### GitHub Actions
Use a [if: failure()](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#failure) condition to upload any `*.received.*` files if the build fails.<!-- include: build-server-githubactions. path: /docs/mdsource/build-server-githubactions.include.md -->
Use a [if: failure()](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#failure) condition to upload any `*.received.*` files if the build fails. <!-- include: build-server-githubactions. path: /docs/mdsource/build-server-githubactions.include.md -->

```yaml
- name: Upload Test Results
Expand All @@ -45,7 +45,7 @@ Use a [if: failure()](https://docs.github.com/en/free-pro-team@latest/actions/re

### Azure DevOps YAML Pipeline

Directly after the test runner step add a build step to set a flag if the testrunner failed. This is done by using a [failed condition](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/conditions?view=azure-devops&tabs=yaml). This flag will be evaluated in the CopyFiles and PublishBuildArtifacts steps below.<!-- include: build-server-azuredevops. path: /docs/mdsource/build-server-azuredevops.include.md -->
Directly after the test runner step add a build step to set a flag if the testrunner failed. This is done by using a [failed condition](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/conditions?view=azure-devops&tabs=yaml). This flag will be evaluated in the CopyFiles and PublishBuildArtifacts steps below. <!-- include: build-server-azuredevops. path: /docs/mdsource/build-server-azuredevops.include.md -->

```yaml
- task: CmdLine@2
Expand Down
4 changes: 2 additions & 2 deletions docs/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To change this file edit the source file and then run MarkdownSnippets.

# Documentation

* [Clipboard](/docs/clipboard.md)<!-- include: doc-index. path: /docs/mdsource/doc-index.include.md -->
* [Clipboard](/docs/clipboard.md) <!-- include: doc-index. path: /docs/mdsource/doc-index.include.md -->
* [Compared to assertions](/docs/compared-to-assertion.md)
* [Verify options](/docs/verify-options.md)
* [VerifyDirectory](/docs/verify-directory.md)
Expand All @@ -31,4 +31,4 @@ To change this file edit the source file and then run MarkdownSnippets.
* [Converters](/docs/converter.md)
* [Explicit Targets](/docs/explicit-targets.md)
* [FSharp Usage](/docs/fsharp.md)
* [Compared to ApprovalTests](/docs/compared-to-approvaltests.md)<!-- endInclude -->
* [Compared to ApprovalTests](/docs/compared-to-approvaltests.md) <!-- endInclude -->
16 changes: 8 additions & 8 deletions docs/wiz/Linux_Other_Cli_Expecto_AppVeyor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ dotnet add package Verify.Expecto

## Implicit Usings

**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`**<!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->
**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`** <!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->

If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`.<!-- endInclude -->
If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`. <!-- endInclude -->


## Source Control

### Includes/Excludes

* **All `*.received.*` files should be excluded from source control.**<!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->
* **All `*.received.*` files should be excluded from source control.** <!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->

eg. add the following to `.gitignore`

Expand All @@ -44,11 +44,11 @@ If using [UseSplitModeForUniqueDirectory](/docs/naming.md#usesplitmodeforuniqued
`*.received/`


All `*.verified.*` files should be committed to source control.<!-- endInclude -->
All `*.verified.*` files should be committed to source control. <!-- endInclude -->

### Text file settings

Text variants of verified and received have the following characteristics:<!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->
Text variants of verified and received have the following characteristics: <!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->

* UTF8 with a [Byte order mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark)
* Newlines as line-feed (lf)
Expand Down Expand Up @@ -89,7 +89,7 @@ trim_trailing_whitespace = false
```


*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.*<!-- endInclude -->
*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.* <!-- endInclude -->

## DiffPlex

Expand Down Expand Up @@ -160,7 +160,7 @@ Tools supported by Linux:

## Getting .received in output on AppVeyor

Use a [on_failure build step](https://www.appveyor.com/docs/build-configuration/#build-pipeline) to call [Push-AppveyorArtifact](https://www.appveyor.com/docs/build-worker-api/#push-artifact).<!-- include: build-server-appveyor. path: /docs/mdsource/build-server-appveyor.include.md -->
Use a [on_failure build step](https://www.appveyor.com/docs/build-configuration/#build-pipeline) to call [Push-AppveyorArtifact](https://www.appveyor.com/docs/build-worker-api/#push-artifact). <!-- include: build-server-appveyor. path: /docs/mdsource/build-server-appveyor.include.md -->

<!-- snippet: AppVeyorArtifacts -->
<a id='snippet-appveyorartifacts'></a>
Expand All @@ -171,5 +171,5 @@ on_failure:
<sup><a href='/src/appveyor.yml#L35-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-appveyorartifacts' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->
See also [Pushing artifacts from scripts](https://www.appveyor.com/docs/packaging-artifacts/#pushing-artifacts-from-scripts).<!-- endInclude -->
See also [Pushing artifacts from scripts](https://www.appveyor.com/docs/packaging-artifacts/#pushing-artifacts-from-scripts). <!-- endInclude -->
14 changes: 7 additions & 7 deletions docs/wiz/Linux_Other_Cli_Expecto_AzureDevOps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ dotnet add package Verify.Expecto

## Implicit Usings

**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`**<!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->
**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`** <!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->

If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`.<!-- endInclude -->
If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`. <!-- endInclude -->


## Source Control

### Includes/Excludes

* **All `*.received.*` files should be excluded from source control.**<!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->
* **All `*.received.*` files should be excluded from source control.** <!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->

eg. add the following to `.gitignore`

Expand All @@ -44,11 +44,11 @@ If using [UseSplitModeForUniqueDirectory](/docs/naming.md#usesplitmodeforuniqued
`*.received/`


All `*.verified.*` files should be committed to source control.<!-- endInclude -->
All `*.verified.*` files should be committed to source control. <!-- endInclude -->

### Text file settings

Text variants of verified and received have the following characteristics:<!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->
Text variants of verified and received have the following characteristics: <!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->

* UTF8 with a [Byte order mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark)
* Newlines as line-feed (lf)
Expand Down Expand Up @@ -89,7 +89,7 @@ trim_trailing_whitespace = false
```


*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.*<!-- endInclude -->
*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.* <!-- endInclude -->

## DiffPlex

Expand Down Expand Up @@ -160,7 +160,7 @@ Tools supported by Linux:

## Getting .received in output on Azure DevOps

Directly after the test runner step add a build step to set a flag if the testrunner failed. This is done by using a [failed condition](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/conditions?view=azure-devops&tabs=yaml). This flag will be evaluated in the CopyFiles and PublishBuildArtifacts steps below.<!-- include: build-server-azuredevops. path: /docs/mdsource/build-server-azuredevops.include.md -->
Directly after the test runner step add a build step to set a flag if the testrunner failed. This is done by using a [failed condition](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/conditions?view=azure-devops&tabs=yaml). This flag will be evaluated in the CopyFiles and PublishBuildArtifacts steps below. <!-- include: build-server-azuredevops. path: /docs/mdsource/build-server-azuredevops.include.md -->

```yaml
- task: CmdLine@2
Expand Down
14 changes: 7 additions & 7 deletions docs/wiz/Linux_Other_Cli_Expecto_GitHubActions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ dotnet add package Verify.Expecto

## Implicit Usings

**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`**<!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->
**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`** <!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->

If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`.<!-- endInclude -->
If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`. <!-- endInclude -->


## Source Control

### Includes/Excludes

* **All `*.received.*` files should be excluded from source control.**<!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->
* **All `*.received.*` files should be excluded from source control.** <!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->

eg. add the following to `.gitignore`

Expand All @@ -44,11 +44,11 @@ If using [UseSplitModeForUniqueDirectory](/docs/naming.md#usesplitmodeforuniqued
`*.received/`


All `*.verified.*` files should be committed to source control.<!-- endInclude -->
All `*.verified.*` files should be committed to source control. <!-- endInclude -->

### Text file settings

Text variants of verified and received have the following characteristics:<!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->
Text variants of verified and received have the following characteristics: <!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->

* UTF8 with a [Byte order mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark)
* Newlines as line-feed (lf)
Expand Down Expand Up @@ -89,7 +89,7 @@ trim_trailing_whitespace = false
```


*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.*<!-- endInclude -->
*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.* <!-- endInclude -->

## DiffPlex

Expand Down Expand Up @@ -160,7 +160,7 @@ Tools supported by Linux:

## Getting .received in output on GitHub Actions

Use a [if: failure()](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#failure) condition to upload any `*.received.*` files if the build fails.<!-- include: build-server-githubactions. path: /docs/mdsource/build-server-githubactions.include.md -->
Use a [if: failure()](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#failure) condition to upload any `*.received.*` files if the build fails. <!-- include: build-server-githubactions. path: /docs/mdsource/build-server-githubactions.include.md -->

```yaml
- name: Upload Test Results
Expand Down
12 changes: 6 additions & 6 deletions docs/wiz/Linux_Other_Cli_Expecto_None.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ dotnet add package Verify.Expecto

## Implicit Usings

**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`**<!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->
**All examples use [Implicit Usings](https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#implicitusings). Ensure the following is set to have examples compile correctly `<ImplicitUsings>enable</ImplicitUsings>`** <!-- include: implicit-usings. path: /docs/mdsource/implicit-usings.include.md -->

If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`.<!-- endInclude -->
If `ImplicitUsings` are not enabled, substitute usages of `Verify()` with `Verifier.Verify()`. <!-- endInclude -->


## Source Control

### Includes/Excludes

* **All `*.received.*` files should be excluded from source control.**<!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->
* **All `*.received.*` files should be excluded from source control.** <!-- include: include-exclude. path: /docs/mdsource/include-exclude.include.md -->

eg. add the following to `.gitignore`

Expand All @@ -44,11 +44,11 @@ If using [UseSplitModeForUniqueDirectory](/docs/naming.md#usesplitmodeforuniqued
`*.received/`


All `*.verified.*` files should be committed to source control.<!-- endInclude -->
All `*.verified.*` files should be committed to source control. <!-- endInclude -->

### Text file settings

Text variants of verified and received have the following characteristics:<!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->
Text variants of verified and received have the following characteristics: <!-- include: text-file-settings. path: /docs/mdsource/text-file-settings.include.md -->

* UTF8 with a [Byte order mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark)
* Newlines as line-feed (lf)
Expand Down Expand Up @@ -89,7 +89,7 @@ trim_trailing_whitespace = false
```


*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.*<!-- endInclude -->
*Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.* <!-- endInclude -->

## DiffPlex

Expand Down
Loading

0 comments on commit 57b9af1

Please sign in to comment.