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
3 changes: 3 additions & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
<ItemGroup>
<GlobalPackageReference Include="SauceControl.InheritDoc" VersionOverride="2.0.2" />
</ItemGroup>
<ItemGroup>
<None Include="$(MSBuildThisFileDirectory)docs/banner.png" Visible="false" Pack="true" PackagePath="docs/" />
<None Include="$(MSBuildThisFileDirectory)docs/logo.png" Visible="false" Pack="true" PackagePath="docs/" />
Expand Down
7 changes: 3 additions & 4 deletions docs/api/create_docker_container.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,9 @@ _ = new ContainerBuilder()

```csharp title="Copying a file"
_ = new ContainerBuilder()
# copy to the `/app` directory
.WithResourceMapping(new FileInfo("appsettings.json"), "/app")

# copy to a specific file
# Copy 'appsettings.json' into the '/app' directory.
.WithResourceMapping(new FileInfo("appsettings.json"), "/app/")
# Copy 'appsettings.Container.json' to '/app/appsettings.Developer.json'.
.WithResourceMapping(new FileInfo("appsettings.Container.json"), new FileInfo("/app/appsettings.Developer.json"));
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ namespace DotNet.Testcontainers.Configurations
using DotNet.Testcontainers.Containers;
using JetBrains.Annotations;

/// <summary>
/// Defines a condition that is repeatedly evaluated until it becomes true.
/// </summary>
[PublicAPI]
public interface IWaitUntil
{
/// <summary>
/// Evaluates the condition asynchronously against the specified container.
/// </summary>
/// <param name="container">The container instance to check readiness against.</param>
/// <returns>A task that returns <c>true</c> when the condition is satisfied; otherwise, <c>false</c>.</returns>
Task<bool> UntilAsync(IContainer container);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ namespace DotNet.Testcontainers.Configurations
using DotNet.Testcontainers.Containers;
using JetBrains.Annotations;

/// <summary>
/// Defines a condition that is repeatedly evaluated while it remains true.
/// </summary>
[PublicAPI]
public interface IWaitWhile
{
/// <summary>
/// Evaluates the condition asynchronously against the specified container.
/// </summary>
/// <param name="container">The container instance to check readiness against.</param>
/// <returns>A task that returns <c>true</c> while the condition holds; otherwise, <c>false</c>.</returns>
Task<bool> WhileAsync(IContainer container);
}
}