Add build options (#67)

mathworks · Feb 15, 2024 · c4a811b · c4a811b
1 parent 4001148
commit c4a811b
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 11 deletions.
diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml
@@ -348,8 +348,17 @@ jobs:
               function buildTask(~)
               f = fopen('buildlog.txt', 'a+'); fprintf(f, 'building\n'); fclose(f);
 
-              function testTask(~)
-              f = fopen('buildlog.txt', 'a+'); fprintf(f, 'testing\n'); fclose(f);
+              function testTask(~,tests,options)
+              arguments
+                ~
+                tests string = "tests"
+                options.OutputDetail (1,1) string = "terse"
+              end
+              f = fopen('buildlog.txt', 'a+');
+              fprintf(f, 'testing\n');
+              fprintf(f, '%s\n', tests);
+              fprintf(f, '%s\n', options.OutputDetail);
+              fclose(f);
 
               function deployTask(~)
               f = fopen('buildlog.txt', 'a+'); fprintf(f, 'deploying\n'); fclose(f);
@@ -367,6 +376,8 @@ jobs:
             set -e
             grep "building" buildlog.txt
             grep "testing" buildlog.txt
+            grep "tests" buildlog.txt
+            grep "terse" buildlog.txt
             grep "deploying" buildlog.txt
             ! grep "checking" buildlog.txt
             rm buildlog.txt
@@ -380,20 +391,39 @@ jobs:
             set -e
             grep "building" buildlog.txt
             grep "testing" buildlog.txt
+            grep "tests" buildlog.txt
+            grep "terse" buildlog.txt
             grep "deploying" buildlog.txt
             grep "checking" buildlog.txt
             rm buildlog.txt
           shell: bash
+      # run build with task args
+      - matlab/run-build:
+          tasks: test("myTests",OutputDetail="concise")
+      - run:
+          name: Verify that correct tasks appear in buildlog.txt
+          command: |
+            set -e
+            grep "building" buildlog.txt
+            grep "testing" buildlog.txt
+            grep "myTests" buildlog.txt
+            grep "concise" buildlog.txt
+            ! grep "deploying" buildlog.txt
+            ! grep "checking" buildlog.txt
+            rm buildlog.txt
+          shell: bash
       # run build with default tasks
       - matlab/run-build:
           startup-options: -logfile console.log
       - run:
-          name: Verify that correct tasks appear in buildlog.txt
+          name: Verify that correct tasks appear in buildlog.txt and console.log
           command: |
             set -e
             grep "building" buildlog.txt
             grep "build" console.log
             grep "testing" buildlog.txt
+            grep "tests" buildlog.txt
+            grep "terse" buildlog.txt
             grep "test" console.log
             ! grep "deploying" buildlog.txt
             ! grep "deploy" console.log
@@ -402,6 +432,22 @@ jobs:
             rm buildlog.txt
             rm console.log
           shell: bash
+      # run build with task skipping
+      - matlab/run-build:
+          tasks: deploy
+          build-options: -skip test
+      - run:
+          name: Verify that correct tasks appear in buildlog.txt
+          command: |
+            set -e
+            grep "building" buildlog.txt
+            ! grep "testing" buildlog.txt
+            ! grep "tests" buildlog.txt
+            ! grep "terse" buildlog.txt
+            grep "deploying" buildlog.txt
+            ! grep "checking" buildlog.txt
+            rm buildlog.txt
+          shell: bash
 
 workflows:
   test-deploy:

diff --git a/devel/contributing.md b/devel/contributing.md
@@ -11,7 +11,7 @@ Familiarize yourself with the best practices in the [orb authoring process](http
 Make changes to the orb in the src folder. After you are done updating, pack and validate the orb locally:
 
 ```
-circleci orb pack > orb.yml
+circleci orb pack src > orb.yml
 circleci orb validate orb.yml
 ```
 Note: the packed orb.yml file does not need to be committed to the repo. CircleCI will take care of all of this on release.

diff --git a/src/commands/run-build.yml b/src/commands/run-build.yml
@@ -10,6 +10,14 @@ parameters:
       in the plan returned by buildfile.m as well as all the tasks on which they depend.
     type: string
     default: ""
+  build-options:
+    description: >
+      MATLAB build options, specified as a list of options separated by spaces. The command
+      supports the same options that you can pass to the `buildtool` command when running a
+      MATLAB build. For more information, see
+      https://www.mathworks.com/help/matlab/ref/buildtool.html.
+    type: string
+    default: ""
   startup-options:
     description: >
       MATLAB startup options. If you specify more than one option, use a space to
@@ -29,7 +37,8 @@ steps:
       name: Run MATLAB build
       environment:
         PARAM_TASKS: <<parameters.tasks>>
-        PARAM_ARGS: <<parameters.startup-options>>
+        PARAM_BUILD_OPTIONS: <<parameters.build-options>>
+        PARAM_STARTUP_OPTIONS: <<parameters.startup-options>>
       command: <<include(scripts/run-build.sh)>>
       shell: bash
       no_output_timeout: <<parameters.no-output-timeout>>
diff --git a/src/commands/run-command.yml b/src/commands/run-command.yml
@@ -31,7 +31,7 @@ steps:
       name: Run MATLAB command
       environment:
         PARAM_COMMAND: <<parameters.command>>
-        PARAM_ARGS: <<parameters.startup-options>>
+        PARAM_STARTUP_OPTIONS: <<parameters.startup-options>>
       command: <<include(scripts/run-command.sh)>>
       shell: bash
       no_output_timeout: <<parameters.no-output-timeout>>
diff --git a/src/commands/run-tests.yml b/src/commands/run-tests.yml
@@ -122,7 +122,7 @@ steps:
         PARAM_USE_PARALLEL: <<parameters.use-parallel>>
         PARAM_OUTPUT_DETAIL: <<parameters.output-detail>>
         PARAM_LOGGING_LEVEL: <<parameters.logging-level>>
-        PARAM_ARGS: <<parameters.startup-options>>
+        PARAM_STARTUP_OPTIONS: <<parameters.startup-options>>
       command: <<include(scripts/run-tests.sh)>>
       shell: bash
       no_output_timeout: <<parameters.no-output-timeout>>
diff --git a/src/scripts/run-build.sh b/src/scripts/run-build.sh
@@ -23,7 +23,14 @@ if [[ $os = CYGWIN* || $os = MINGW* || $os = MSYS* ]]; then
 fi
 
 # create buildtool command from parameters
-buildCommand="buildtool ${PARAM_TASKS}"
+buildCommand="buildtool"
+
+if [ -n "$PARAM_TASKS" ]; then
+    buildCommand+=" ${PARAM_TASKS}"
+fi
+if [ -n "$PARAM_BUILD_OPTIONS" ]; then
+    buildCommand+=" ${PARAM_BUILD_OPTIONS}"
+fi
 
 # create script to execute
 script=command_${RANDOM}
@@ -34,4 +41,4 @@ $buildCommand
 EOF
 
 # run MATLAB command
-"${tmpdir}/bin/run-matlab-command$binext" "setenv('MW_ORIG_WORKING_FOLDER', cd('${scriptdir//\'/\'\'}'));$script" $PARAM_ARGS
+"${tmpdir}/bin/run-matlab-command$binext" "setenv('MW_ORIG_WORKING_FOLDER', cd('${scriptdir//\'/\'\'}'));$script" $PARAM_STARTUP_OPTIONS
diff --git a/src/scripts/run-command.sh b/src/scripts/run-command.sh
@@ -31,4 +31,4 @@ ${PARAM_COMMAND}
 EOF
 
 # run MATLAB command
-"${tmpdir}/bin/run-matlab-command$binext" "setenv('MW_ORIG_WORKING_FOLDER', cd('${scriptdir//\'/\'\'}'));$script" $PARAM_ARGS
+"${tmpdir}/bin/run-matlab-command$binext" "setenv('MW_ORIG_WORKING_FOLDER', cd('${scriptdir//\'/\'\'}'));$script" $PARAM_STARTUP_OPTIONS
diff --git a/src/scripts/run-tests.sh b/src/scripts/run-tests.sh
@@ -47,4 +47,4 @@ fi
     disp('Running MATLAB script with contents:');\
     disp(testScript.Contents);\
     fprintf('__________\n\n');\
-    run(testScript);" $PARAM_ARGS
+    run(testScript);" $PARAM_STARTUP_OPTIONS