Skip to content

Refactoring pipeline actions and cmdline interface #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Neko-Box-Coder wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Refactoring pipeline actions and cmdline interface #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ecaee68
Updating CleanupDependencies() to warn user when deps not found to reset
Neko-Box-Coder Jul 2, 2026
9cca1d3
Major refactor on how different actions are run & cmdline interface
Neko-Box-Coder Jul 2, 2026
983c995
Updating README and documentation to match the refactored cmdline
Neko-Box-Coder Jul 4, 2026
24628bd
Updating DSResult
Neko-Box-Coder Jul 4, 2026
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
91 changes: 63 additions & 28 deletions Examples/InteractiveTutorial.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Defines: ["ssLOG_USE_SOURCE=1"]
std::string runcpp2ExecutablePath = "";
std::string downloadBranch = "heads/master";
bool integrationTest = false;
std::string extraOptions = "";

#define DELAYED_OUTPUT(str) \
do \
Expand Down Expand Up @@ -124,7 +125,7 @@ bool InitializeRuncpp2ExecutablePath()
while(true)
{
System2CommandInfo commandInfo = {0};
SYSTEM2_RESULT result = System2CppRun("runcpp2 --version", commandInfo);
SYSTEM2_RESULT result = System2CppRun("runcpp2 version", commandInfo);
if(result != SYSTEM2_RESULT_SUCCESS)
return false;

Expand Down Expand Up @@ -309,17 +310,16 @@ int main(int, char**)

DELAYED_OUTPUT("A simple hello world file is created (\"tutorial/main.cpp\").");
DELAYED_OUTPUT("Now, let's run it.");
if(!RunCommandWithPrompt(runcpp2ExecutablePath + " tutorial/main.cpp"))
if(!RunCommandWithPrompt(runcpp2ExecutablePath + " run" + extraOptions + " tutorial/main.cpp"))
return false;

DELAYED_OUTPUT("Seems simple enough.\n");

DELAYED_OUTPUT("Let's build the script instead of running it.");
DELAYED_OUTPUT("Unless specified, input file is treated as `Executable`\n");

DELAYED_OUTPUT( "We can get the binary files of the script by "
"using the `--build` (or `-b`) option.");
DELAYED_OUTPUT( "And we can specify the output directory for the binary files with `--output` "
"using the `build` option.");
DELAYED_OUTPUT( "And we can specify the output directory for the binary files with `--output-dir` "
"(or `-o`)");
DELAYED_OUTPUT( "We also need to pass the `--executable` (or `-e`) option to "
"explicitly get an executable file. \n"
Expand All @@ -328,8 +328,8 @@ int main(int, char**)

DELAYED_OUTPUT("Let's try it");
if(!RunCommandWithPrompt( runcpp2ExecutablePath +
" --build --output ./tutorial --executable "
"tutorial/main.cpp"))
" build --output-dir ./tutorial --executable" + extraOptions +
" tutorial/main.cpp"))
{
return false;
}
Expand All @@ -355,37 +355,43 @@ int main(int, char**)

DELAYED_OUTPUT( "Sometimes you want to remove the cache of the script before running it again.\n"
"You can do that by using the `--rebuild` (or `-rb`) option.");
if(!RunCommandWithPrompt(runcpp2ExecutablePath + " --rebuild ./tutorial/main.cpp"))
if(!RunCommandWithPrompt( runcpp2ExecutablePath + " build --rebuild" + extraOptions +
" ./tutorial/main.cpp"))
{
return false;
}

DELAYED_OUTPUT("You can also see the build/run process by changing the log level to `info`.");
DELAYED_OUTPUT("Let's rebuild the cache again and see the build process.");
if(!RunCommandWithPrompt( runcpp2ExecutablePath +
" --rebuild --log-level info ./tutorial/main.cpp"))
" build --rebuild --log-level info" + extraOptions +
" ./tutorial/main.cpp"))
{
return false;
}

DELAYED_OUTPUT( "runcpp2 also can give realtime error feedback by using "
"the `--watch` (or `-w`) option.");
DELAYED_OUTPUT( "runcpp2 also can give realtime error feedback by using the `watch` option.");
DELAYED_OUTPUT("I would love to show it here but it will block this tutorial.");
DELAYED_OUTPUT("Feel free to try it yourself. "
"Make a change, or an error, then run `runcpp2 --watch tutorial/main.cpp`");
"Make a change, or an error, then run `runcpp2 watch tutorial/main.cpp`");
DELAYED_OUTPUT("Once you are done, you can revert the changes and continue the tutorial.");
DELAYED_OUTPUT("Press enter to continue...");
GetInput(true);

DELAYED_OUTPUT( "You can find the path to your config file and all the builds "
"with the `--show-config-path` (or `-sc`) option.");
if(!RunCommandWithPrompt(runcpp2ExecutablePath + " --show-config-path"))
"with the `show-config-path` option.");
if(!RunCommandWithPrompt(runcpp2ExecutablePath + " show-config-path"))
return false;
DELAYED_OUTPUT("Feel free to make any changes to the config file.\n");

DELAYED_OUTPUT( "Finally, you can specify your script to be built in the current directory "
"with the `--local` (or `-l`) option. \n"
"This will create and build in the `.runcpp2` directory");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " --local main.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run --local" +
extraOptions + " main.cpp"))
{
return false;
}

#ifdef _WIN32
if(!RunCommandWithPrompt("dir tutorial"))
Expand Down Expand Up @@ -485,8 +491,11 @@ bool Chapter2_BuildConfig()

DELAYED_OUTPUT("I have just added the output line");
DELAYED_OUTPUT("Now let's run the script");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" + extraOptions +
" main.cpp"))
{
return false;
}

DELAYED_OUTPUT( "You should see the output `42`. \n"
"You can specify different settings for different platforms and profiles.");
Expand Down Expand Up @@ -560,8 +569,11 @@ bool Chapter2_BuildConfig()
}

DELAYED_OUTPUT("Now let me run the script again, nothing should have changed.");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" + extraOptions +
" main.cpp"))
{
return false;
}

DELAYED_OUTPUT("");
DELAYED_OUTPUT("A common build config is to specify other source files.");
Expand Down Expand Up @@ -664,8 +676,11 @@ void CallHello();
}

DELAYED_OUTPUT("Let's run the script again.");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" + extraOptions +
" main.cpp"))
{
return false;
}

DELAYED_OUTPUT("You should see the output `Hello from another C++ file`.");
DELAYED_OUTPUT("");
Expand All @@ -687,8 +702,11 @@ IncludePaths: ["./"]

DELAYED_OUTPUT("I have just updated the YAML file to omit `DefaultPlatform` and `DefaultProfile`.");
DELAYED_OUTPUT("It's much more concise now. Let's run the script again.");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" + extraOptions +
" main.cpp"))
{
return false;
}

DELAYED_OUTPUT("You should see the same output as before.");
DELAYED_OUTPUT("");
Expand Down Expand Up @@ -723,7 +741,8 @@ IncludePaths: ["./"]
"it will use the \"-E\" flag.");
DELAYED_OUTPUT("If you are using msvc and you are on Windows, it will use the \"/P\" flag.");
DELAYED_OUTPUT("Let's run the script now.");
RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp");
RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" + extraOptions +
" main.cpp");

DELAYED_OUTPUT("");
DELAYED_OUTPUT( "You probably see some errors for linking, this is expected since the "
Expand All @@ -746,7 +765,7 @@ IncludePaths: ["./"]
DELAYED_OUTPUT("You can do that by using the `--create-script-template`/ `-t` option.");
DELAYED_OUTPUT("This will either create a new file or prepend the template to the existing file.");

if(!RunCommandWithPrompt(runcpp2ExecutablePath + " -t tutorial/template.yaml"))
if(!RunCommandWithPrompt(runcpp2ExecutablePath + " template tutorial/template.yaml"))
return false;

DELAYED_OUTPUT("You can see the template in tutorial/template.yaml");
Expand Down Expand Up @@ -809,8 +828,11 @@ bool Chapter3_ExternalDependencies()
DELAYED_OUTPUT( "Next, you have \"LibraryType\" which tells runcpp2 what type of dependency "
"this is. Other options include \"Static\", \"Object\" and \"Shared\"");
DELAYED_OUTPUT("That's pretty much it for a header only library. Let's run it shall we?");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " Logging.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" + extraOptions +
" Logging.cpp"))
{
return false;
}

DELAYED_OUTPUT("Let's try an external shared library");
DELAYED_OUTPUT("Let me query and download an example for you.");
Expand Down Expand Up @@ -864,14 +886,20 @@ bool Chapter3_ExternalDependencies()
"the script for the first time. Let's run it now.");
if(!integrationTest)
{
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " SDLWindow.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" +
extraOptions + " SDLWindow.cpp"))
{
return false;
}
}
else
{
DELAYED_OUTPUT("running SDLWindow.cpp skipped for integration testing");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " --build SDLWindow.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " build" +
extraOptions + " SDLWindow.cpp"))
{
return false;
}
}

DELAYED_OUTPUT("You can also have a dependency as a standalone YAML file which you can import.");
Expand Down Expand Up @@ -1021,14 +1049,20 @@ bool Chapter3_ExternalDependencies()
DELAYED_OUTPUT("Let's run it now.");
if(!integrationTest)
{
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " SDLWindow.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " run" +
extraOptions + " SDLWindow.cpp"))
{
return false;
}
}
else
{
DELAYED_OUTPUT("running SDLWindow.cpp skipped for integration testing");
if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " --build SDLWindow.cpp"))
if(!RunCommandWithPrompt( "cd tutorial && " + runcpp2ExecutablePath + " build" +
extraOptions + " SDLWindow.cpp"))
{
return false;
}
}

DELAYED_OUTPUT("This concludes the 3rd chapter of the tutorial.");
Expand Down Expand Up @@ -1077,14 +1111,15 @@ int main(int argc, char* argv[])
return 1;
}

runcpp2ExecutablePath = exePath.string() + " -l -c " + configPath.string();
runcpp2ExecutablePath = exePath.string();
extraOptions = " -l -c " + configPath.string();
}

//Get runcpp2 version
{
System2CommandInfo commandInfo = {0};
commandInfo.RedirectOutput = true;
SYSTEM2_RESULT result = System2CppRun(runcpp2ExecutablePath + " --version", commandInfo);
SYSTEM2_RESULT result = System2CppRun(runcpp2ExecutablePath + " version", commandInfo);
#define CHECK_RESULT() \
if(result != SYSTEM2_RESULT_SUCCESS) \
{ \
Expand Down
2 changes: 1 addition & 1 deletion External/DSResult
Open in desktop
Submodule DSResult updated 2 files
+1 −1 External/debugbreak
+14 −5 Include/DSResult/DSResult.hpp
32 changes: 16 additions & 16 deletions Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,10 +358,10 @@ pipeline
unstash 'linux_build'
bash "ls -lah"
bash "ls -lah ./Build/Src/Tests"
bash "cd ./Build && ./runcpp2 -l " +
bash "cd ./Build && ./runcpp2 run -l " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/Test.cpp"
bash "cd ./Build && ./runcpp2 -l -b -o . " +
bash "cd ./Build && ./runcpp2 build -l -o . " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/Test.cpp"
bash "ls -lah ./Build"
Expand All @@ -372,7 +372,7 @@ pipeline
unstash 'linux_build'
bash "ls -lah"
bash "ls -lah ./Build/Src/Tests"
bash "cd ./Build && ./runcpp2 -l -b -o . " +
bash "cd ./Build && ./runcpp2 build -l -o . " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/TestStatic.cpp"
bash "ls -lah ./Build"
Expand All @@ -383,7 +383,7 @@ pipeline
unstash 'linux_build'
bash "ls -lah"
bash "ls -lah ./Build/Src/Tests"
bash "cd ./Build && ./runcpp2 -l " +
bash "cd ./Build && ./runcpp2 run -l " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/TestLocalDependency.cpp"

Expand All @@ -392,7 +392,7 @@ pipeline
unstash 'linux_build'
bash "ls -lah"
bash "ls -lah ./Build/Src/Tests"
bash "cd ./Build && ./runcpp2 -l " +
bash "cd ./Build && ./runcpp2 run -l " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/TestSeparateYaml.cpp"

Expand All @@ -404,7 +404,7 @@ pipeline
script
{
def retResult =
sh( script: "cd ./Build && ./runcpp2 -l " +
sh( script: "cd ./Build && ./runcpp2 run -l " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/TestMissingSource.yaml",
returnStatus: true)
Expand All @@ -416,7 +416,7 @@ pipeline
unstash 'linux_build'
bash "ls -lah"
bash "ls -lah ./Build/Src/Tests"
bash "cd ./Build && ./runcpp2 -l " +
bash "cd ./Build && ./runcpp2 run -l " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"--log-level info ../Tests/YamlOnlyTest.yaml"

Expand All @@ -425,7 +425,7 @@ pipeline
unstash 'linux_build'
bash "ls -lah"
bash "ls -lah ./Build/Src/Tests"
bash "cd ./Build && ./runcpp2 -l " +
bash "cd ./Build && ./runcpp2 run -l " +
"-c ../DefaultYAMLs/DefaultUserConfig.yaml " +
"../Examples/InteractiveTutorial.cpp --test " +
"./runcpp2 ../DefaultYAMLs/DefaultUserConfig.yaml"
Expand Down Expand Up @@ -458,10 +458,10 @@ pipeline
bat 'dir'
unstash 'windows_build'
bat 'dir'
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe run -l " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\Test.cpp"
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l -b -o . " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe build -l -o . " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\Test.cpp"
bat "dir .\\Build\\Debug"
Expand All @@ -471,7 +471,7 @@ pipeline
bat 'dir'
unstash 'windows_build'
bat 'dir'
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l -b -o . " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe build -l -o . " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\TestStatic.cpp"
bat "dir .\\Build\\Debug"
Expand All @@ -481,15 +481,15 @@ pipeline
bat 'dir'
unstash 'windows_build'
bat 'dir'
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe run -l " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\TestLocalDependency.cpp"

cleanWs()
bat 'dir'
unstash 'windows_build'
bat 'dir'
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe run -l " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\TestSeparateYaml.cpp"

Expand All @@ -500,7 +500,7 @@ pipeline
script
{
def retResult =
bat(script: "cd .\\Build\\Debug && .\\runcpp2.exe -l " +
bat(script: "cd .\\Build\\Debug && .\\runcpp2.exe run -l " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\TestMissingSource.yaml",
returnStatus: true)
Expand All @@ -511,15 +511,15 @@ pipeline
bat 'dir'
unstash 'windows_build'
bat 'dir'
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe run -l " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"--log-level info ..\\..\\Tests\\YamlOnlyTest.yaml"

cleanWs()
bat 'dir'
unstash 'windows_build'
bat 'dir'
bat "cd .\\Build\\Debug && .\\runcpp2.exe -l " +
bat "cd .\\Build\\Debug && .\\runcpp2.exe run -l " +
"-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " +
"..\\..\\Examples\\InteractiveTutorial.cpp --test " +
".\\runcpp2.exe ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml"
Expand Down
Loading