From c25a6f4db874a32488f675606e4c1e9eb1504c32 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C4=B0smail=20=C3=87A=C4=9EDA=C5=9E?=
 <ismailcagdas@gmail.com>
Date: Tue, 8 Sep 2020 17:04:04 +0300
Subject: [PATCH] added build command documentation

---
 docs/en/CLI.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)

diff --git a/docs/en/CLI.md b/docs/en/CLI.md
index 36f3b8e105..409288755b 100644
--- a/docs/en/CLI.md
+++ b/docs/en/CLI.md
@@ -39,6 +39,7 @@ Here, the list of all available commands before explaining their details:
 * **`translate`**: Simplifies to translate localization files when you have multiple JSON [localization](Localization.md) files in a source control repository.
 * **`login`**: Authenticates on your computer with your [abp.io](https://abp.io/) username and password.
 * **`logout`**: Logouts from your computer if you've authenticated before.
+* **`build`**: Builds a GIT repository and depending repositories or a single .NET solution.
 
 ### help
 
@@ -332,3 +333,90 @@ Logs you out by removing the session token from your computer.
 abp logout
 ```
 
+### build
+
+Building a .NET project is hard when the project references a project reference outside of the solution or even from a different GIT repository. This command builds a GIT repository and it's depending repositories or a single .NET solution File. In order ```build``` command to work, it must be executed in a directory which contains one of;
+
+* A .NET solution file (*.sln)
+* abp-build-config.json
+
+When the executing directory contains a .NET solution file, ```build``` command builds all the projects in the related solution file and all project references on building project files recursively. 
+
+When the executing directory contains a ```abp-build-config.json```, ```build``` command builds all changed projects form its last build and all project references on building project files recursively. 
+
+```abp-build-config.json``` contains properties below;
+
+* ```Name```: Name of the GIT repository. This can be friendly name of your GIT repository or any other unique string for the repository.
+* ```RootPath```: Root path of the repository which contains ```.git``` folder.
+* ```DependingRepositories```: Depending repository list of a repository. Each depending repository item contains same fields as a repository.
+* ```IgnoredDirectories```: Relative directory paths to ignore while building a GIT repository.
+
+A sample ```abp-build-config.json``` looks like for a Windows OS;
+
+````json
+{
+    "Name": "main-repository",
+	"RootPath": "D:\\GitHub\\main-repository",
+    "DependingRepositories": [{
+        "Name": "module-repository",
+		"RootPath": "D:\\GitHub\\module-repository"
+    }],
+	"IgnoredDirectories": [
+		"utils"
+	]
+}
+````
+
+ABP CLI stores a build status file for builds using the repository friendly names and current branch names in the;
+
+* ```%USERPROFILE%\.abp\build\``` for Windows.
+* ```$HOME/.abp/build/``` for Linux/macOS.
+
+and uses this file when building same repository next time and only builds affected projects and decreases the total build time. A sample build status file content looks like;
+
+````json
+{
+  "RepositoryName": "main-repository",
+  "BranchName": "dev",
+  "CommitId": "84ecde8ba275aeeb14d24a87ad46a1e941adf8ba",
+  "SucceedProjects": [
+    {
+      "CsProjPath": "D:\\GitHub\\main-repository\\BookStore\\BookStore.Web.csproj",
+      "CommitId": "84ecde8ba275aeeb14d24a87ad46a1e941adf8ba"
+    }
+  ],
+  "DependingRepositories": [
+    {
+      "RepositoryName": "module-repository",
+      "BranchName": "dev",
+      "CommitId": "0598b8e45af9507fc9ba8abf304e78fc7d434e04",
+      "SucceedProjects": [
+        {
+          "CsProjPath": "D:\\GitHub\\module-repository\\identity-module\Identity\\Identity.Web.csproj",
+          "CommitId": "0598b8e45af9507fc9ba8abf304e78fc7d434e04"
+        }
+      ],
+      "DependingRepositories": []
+    }
+  ]
+}
+````
+
+When building a single .NET solution file, its belonging GIT repository is used to generate this file.
+
+After each build, this status file is updated with latest build information.
+
+Usage:
+
+````bash
+abp build [options]
+````
+
+#### Options
+
+* ```--working-directory``` or ```-w```: Specifies the working directory. This option is useful when the command is executed outside of a GIT repository or when executing directory doesn't contain a .NET solution file.
+* ```--build-name``` or ```-n```: Specifies a name for the build. This option is useful when same repository is used for more than one different builds. 
+* ```--dotnet-build-arguments``` or ```-a```: Arguments to pass ```dotnet build``` when building project files. 
+* ```--max-parallel-builds``` or ```-m```: Max parallel build count when building child projects of a project.
+* ```--force```: Forces to build projects even they are not changed from the last successful build.
+