Add documentation for the --artifacts-path command option (#40637)

dotnet · Apr 29, 2024 · 3b5fccd · 3b5fccd
1 parent 8ba2a60
commit 3b5fccd
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 3 deletions.
diff --git a/docs/core/tools/dotnet-build.md b/docs/core/tools/dotnet-build.md
@@ -15,6 +15,7 @@ ms.date: 11/27/2023
 
 ```dotnetcli
 dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
+    [--artifacts-path <ARTIFACTS_DIR>]
     [-c|--configuration <CONFIGURATION>] [-f|--framework <FRAMEWORK>]
     [--disable-build-servers]
     [--force] [--interactive] [--no-dependencies] [--no-incremental]
@@ -84,6 +85,8 @@ The project or solution file to build. If a project or solution file isn't speci
 
 [!INCLUDE [arch](../../../includes/cli-arch.md)]
 
+[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
+
 [!INCLUDE [configuration](../../../includes/cli-configuration.md)]
 
 [!INCLUDE [disable-build-servers](../../../includes/cli-disable-build-servers.md)]

diff --git a/docs/core/tools/dotnet-clean.md b/docs/core/tools/dotnet-clean.md
@@ -14,7 +14,8 @@ ms.date: 02/14/2020
 ## Synopsis
 
 ```dotnetcli
-dotnet clean [<PROJECT>|<SOLUTION>] [-c|--configuration <CONFIGURATION>]
+dotnet clean [<PROJECT>|<SOLUTION>] [--artifacts-path <ARTIFACTS_DIR>]
+    [-c|--configuration <CONFIGURATION>]
     [-f|--framework <FRAMEWORK>] [--interactive]
     [--nologo] [-o|--output <OUTPUT_DIRECTORY>]
     [-r|--runtime <RUNTIME_IDENTIFIER>] [--tl:[auto|on|off]]
@@ -35,6 +36,8 @@ The MSBuild project or solution to clean. If a project or solution file is not s
 
 ## Options
 
+[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
+
 [!INCLUDE [configuration](../../../includes/cli-configuration-clean.md)]
 
 * **`-f|--framework <FRAMEWORK>`**

diff --git a/docs/core/tools/dotnet-pack.md b/docs/core/tools/dotnet-pack.md
@@ -14,8 +14,9 @@ ms.date: 04/04/2024
 ## Synopsis
 
 ```dotnetcli
-dotnet pack [<PROJECT>|<SOLUTION>] [-c|--configuration <CONFIGURATION>]
-    [--force] [--include-source] [--include-symbols] [--interactive]
+dotnet pack [<PROJECT>|<SOLUTION>] [--artifacts-path <ARTIFACTS_DIR>]
+    [-c|--configuration <CONFIGURATION>] [--force]
+    [--include-source] [--include-symbols] [--interactive]
     [--no-build] [--no-dependencies] [--no-restore] [--nologo]
     [-o|--output <OUTPUT_DIRECTORY>] [--runtime <RUNTIME_IDENTIFIER>]
     [-s|--serviceable] [--tl:[auto|on|off]] [-v|--verbosity <LEVEL>]
@@ -59,6 +60,8 @@ You can provide MSBuild properties to the `dotnet pack` command for the packing
 
 ## Options
 
+[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
+
 [!INCLUDE [configuration](../../../includes/cli-configuration-publish-pack.md)]
 
 - **`--force`**

diff --git a/docs/core/tools/dotnet-publish.md b/docs/core/tools/dotnet-publish.md
@@ -15,6 +15,7 @@ ms.date: 04/04/2024
 
 ```dotnetcli
 dotnet publish [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
+    [--artifacts-path <ARTIFACTS_DIR>]
     [-c|--configuration <CONFIGURATION>] [--disable-build-servers]
     [-f|--framework <FRAMEWORK>] [--force] [--interactive]
     [--manifest <PATH_TO_MANIFEST_FILE>] [--no-build] [--no-dependencies]
@@ -125,6 +126,8 @@ For more information, see the following resources:
 
 [!INCLUDE [arch](../../../includes/cli-arch.md)]
 
+[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
+
 [!INCLUDE [configuration](../../../includes/cli-configuration-publish-pack.md)]
 
 [!INCLUDE [disable-build-servers](../../../includes/cli-disable-build-servers.md)]

diff --git a/docs/core/tools/dotnet-test.md b/docs/core/tools/dotnet-test.md
@@ -17,6 +17,7 @@ ms.date: 03/27/2024
 dotnet test [<PROJECT> | <SOLUTION> | <DIRECTORY> | <DLL> | <EXE>]
     [--test-adapter-path <ADAPTER_PATH>]
     [-a|--arch <ARCHITECTURE>]
+    [--artifacts-path <ARTIFACTS_DIR>]
     [--blame]
     [--blame-crash]
     [--blame-crash-dump-type <DUMP_TYPE>]
@@ -94,6 +95,8 @@ Where `Microsoft.NET.Test.Sdk` is the test host, `xunit` is the test framework.
 
 [!INCLUDE [arch-no-a](../../../includes/cli-arch-no-a.md)]
 
+[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
+
 - **`--blame`**
 
   Runs the tests in blame mode. This option is helpful in isolating problematic tests that cause the test host to crash. When a crash is detected, it creates a sequence file in `TestResults/<Guid>/<Guid>_Sequence.xml` that captures the order of tests that were run before the crash.

diff --git a/includes/cli-artifacts-path.md b/includes/cli-artifacts-path.md
@@ -0,0 +1,9 @@
+---
+author: tdykstra
+ms.author: tdykstra
+ms.date: 26/04/2024
+ms.topic: include
+---
+- **`--artifacts-path <ARTIFACTS_DIR>`**
+
+  All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see [Artifacts Output Layout](../docs/core/sdk/artifacts-output.md). Available since .NET 8 SDK.