Adding branch & full history options for git dependency source

Author: Neko-Box-Coder

DefaultYAMLs/DefaultScriptInfo.yaml

@@ -149,6 +149,13 @@ Dependencies:
         Git:
             # Git repository URL
             URL: "https://github.com/MyUser/MyLibrary.git"
+            
+            # (Optional) Branch name or tag name. Full ref path is accepted as well. 
+            #            Defaults to default branch on specified git repo if this is not specified
+            # Branch: "MyBranch"
+            
+            # (Optional) Checkout full git history or just the target commit. Defaults to false
+            # FullHistory: false
 
         # Dependency or import YAML file exists in local filesystem directory, 
         #   and needs to be copied to build directory

Include/runcpp2/Data/GitSource.hpp

@@ -12,6 +12,8 @@ namespace runcpp2
         {
             public:
                 std::string URL;
+                std::string Branch;
+                bool FullHistory = false;
 
                 bool ParseYAML_Node(ryml::ConstNodeRef& node);
                 std::string ToString(std::string indentation) const;
@@ -20,4 +22,4 @@ namespace runcpp2
     }
 }
 
-#endif 
+#endif 

Src/Tests/Data/DependencySourceTest.cpp

@@ -17,6 +17,8 @@ int main(int argc, char** argv)
             const char* yamlStr = R"(
                 Git:
                     URL: https://github.com/user/repo.git
+                    Branch: master
+                    FullHistory: true
             )";
 
             ryml::Tree tree = ryml::parse_in_arena(c4::to_csubstr(yamlStr));
@@ -37,7 +39,9 @@ int main(int argc, char** argv)
         const runcpp2::Data::GitSource* git = 
             mpark::get_if<runcpp2::Data::GitSource>(&dependencySource.Source);
         ssTEST_OUTPUT_ASSERT("Should be Git source", git != nullptr);
-        ssTEST_OUTPUT_ASSERT("URL", git->URL == "https://github.com/user/repo.git");
+        ssTEST_OUTPUT_ASSERT("URL", git->URL, "https://github.com/user/repo.git");
+        ssTEST_OUTPUT_ASSERT("Branch", git->Branch, "master");
+        ssTEST_OUTPUT_ASSERT("FullHistory", git->FullHistory, true);
 
         //Test ToString() and Equals()
         ssTEST_OUTPUT_EXECUTION
@@ -184,9 +188,34 @@ int main(int argc, char** argv)
             bool parseResult = dependencySource.ParseYAML_Node(nodeRef);
         );
 
-        ssTEST_OUTPUT_ASSERT("ParseYAML_Node should fail", !parseResult);
+        ssTEST_OUTPUT_ASSERT("ParseYAML_Node should fail", parseResult, false);
     };
-    
+
+    ssTEST("DependencySource Should Handle Invalid FullHistory Option")
+    {
+        ssTEST_OUTPUT_SETUP
+        (
+            const char* yamlStr = R"(
+                Git:
+                    URL: https://github.com/user/repo.git
+                    FullHistory: What
+            )";
+            
+            ryml::Tree tree = ryml::parse_in_arena(c4::to_csubstr(yamlStr));
+            ryml::ConstNodeRef root = tree.rootref();
+            
+            runcpp2::Data::DependencySource dependencySource;
+        );
+        
+        ssTEST_OUTPUT_EXECUTION
+        (
+            ryml::ConstNodeRef nodeRef = root;
+            bool parseResult = dependencySource.ParseYAML_Node(nodeRef);
+        );
+        
+        ssTEST_OUTPUT_ASSERT("ParseYAML_Node should fail", parseResult, false);
+    };
+
     ssTEST_END_TEST_GROUP();
     return 0;
 }

Src/runcpp2/Data/GitSource.cpp

@@ -9,7 +9,9 @@ bool runcpp2::Data::GitSource::ParseYAML_Node(ryml::ConstNodeRef& node)
 
     std::vector<NodeRequirement> requirements =
     {
-        NodeRequirement("URL", ryml::NodeType_e::KEYVAL, true, false)
+        NodeRequirement("URL", ryml::NodeType_e::KEYVAL, true, false),
+        NodeRequirement("Branch", ryml::NodeType_e::KEYVAL, false, false),
+        NodeRequirement("FullHistory", ryml::NodeType_e::KEYVAL, false, false)
     };
 
     if(!CheckNodeRequirements(node, requirements))
@@ -19,6 +21,12 @@ bool runcpp2::Data::GitSource::ParseYAML_Node(ryml::ConstNodeRef& node)
     }
 
     node["URL"] >> URL;
+    if(ExistAndHasChild(node, "Branch"))
+        node["Branch"] >> Branch;
+    
+    if(ExistAndHasChild(node, "FullHistory"))
+        node["FullHistory"] >> FullHistory;
+    
     return true;
 
     INTERNAL_RUNCPP2_SAFE_CATCH_RETURN(false);
@@ -29,10 +37,13 @@ std::string runcpp2::Data::GitSource::ToString(std::string indentation) const
     std::string out;
     out += indentation + "Git:\n";
     out += indentation + "    URL: " + GetEscapedYAMLString(URL) + "\n";
+    if(!Branch.empty())
+        out += indentation + "    Branch: " + GetEscapedYAMLString(Branch) + "\n";
+    out += indentation + "    FullHistory: " + (FullHistory ? "true" : "false") + "\n";
     return out;
 }
 
 bool runcpp2::Data::GitSource::Equals(const GitSource& other) const
 {
-    return URL == other.URL;
-} 
+    return URL == other.URL && Branch == other.Branch && FullHistory == other.FullHistory;
+} 

Src/runcpp2/DependenciesHelper.cpp

@@ -115,7 +115,15 @@ namespace
                 const runcpp2::Data::GitSource* git = 
                     mpark::get_if<runcpp2::Data::GitSource>(&(dependency.Source.Source));
 
-                std::string gitCloneCommand = "git clone " + git->URL;
+                std::string gitCloneCommand =
+                    std::string("git clone ") + 
+                    (git->FullHistory ? "" : "--depth 1 ") + 
+                    (
+                        git->Branch.empty() ? 
+                        std::string("") : 
+                        std::string("--branch ") + git->Branch
+                    ) +
+                    git->URL;
 
                 ssLOG_INFO("Running git clone command: " << gitCloneCommand << " in " << 
                             buildDir.string());

mkdocs/docs/TODO.md

@@ -1,11 +1,16 @@
 # Roadmap
 
-## Planned
+## Done
+
+!!! info "`latest` version"
+    - Async/Multi-thread compile and dependencies processing
+    - More git options
+        - Add branch/tag option for git
+        - Add initialize submodule option for git
+
 
+## Planned
 - Ability to skip DefaultPlatform and DefaultProfile
-- More git options
-    - Add branch/tag option for git
-    - Add initialize submodule option for git
 - Allow runcpp2 to be library for scriptable pipeline
 - Smoother CMake support by reading cmake target properties (https://stackoverflow.com/a/56738858/23479578)
 - Add the ability for user to specify custom substitution options which applies to all fields
@@ -37,6 +42,4 @@
 - Allow Languages to override FileExtensions in compiler profile (?)
 - Custom Platform
 - Ability to specify custom run commands
-- 
-
 

mkdocs/docs/build_settings.md

@@ -312,6 +312,18 @@
                         - Optional: `false`
                         - Default: None
                         - Description: The url of the git repository.
+                    - `Branch`
+                        - Type: `string`
+                        - Optional: `true`
+                        - Default: None
+                        - Description: Branch name or tag name. Full ref path is accepted as well. 
+                        - !!! info "This requires `latest` version"
+                    - `FullHistory`
+                        - Type: `bool`
+                        - Optional: `true`
+                        - Default: `false`
+                        - Description: Checkout full git history or just the target commit.
+                        - !!! info "This requires `latest` version"
             - `Local`
                 - Type: `map` with child fields
                 - Optional: `true` if `ImportPath` is specified or `Git` is specified
@@ -547,6 +559,13 @@ Dependencies:
         Git:
             # Git repository URL
             URL: "https://github.com/MyUser/MyLibrary.git"
+            
+            # (Optional) Branch name or tag name. Full ref path is accepted as well. 
+            #            Defaults to default branch on specified git repo if this is not specified
+            # Branch: "MyBranch"
+            
+            # (Optional) Checkout full git history or just the target commit. Defaults to false
+            # FullHistory: false
 
         # Dependency or import YAML file exists in local filesystem directory, 
         #   and needs to be copied to build directory

mkdocs/docs/guides/external_dependencies.md

@@ -35,6 +35,7 @@ This is configured under the `Source` section. We currently support 2 sources:
         Source:
             Git:
                 URL: "https://github.com/MyUser/MyLibrary.git"
+                
         LibraryType: Static
         IncludePaths:
         -   "include/MyLibrary"
@@ -56,6 +57,30 @@ This is configured under the `Source` section. We currently support 2 sources:
 
 ---
 
+## Specifying Git Clone Options
+
+!!! info "This requires `latest` version"
+
+You can specify the target branch/tag name and to clone whole git history or not with:
+`Branch` and `FullHistory`. 
+
+A normal clone without full history will be performed if none of these are specified.
+
+???+ example
+    ```yaml
+    Dependencies:
+    ...
+        Source:
+            Git:
+                URL: "https://github.com/MyUser/MyLibrary.git"
+                Branch: "SpecialBranch"
+                FullHistory: true
+    ...
+    ```
+
+
+---
+
 ## Adding Include Paths And Link Settings
 
 ### Include Paths