ci template

Author: scivision

.github/workflows/ci.yml

@@ -6,6 +6,10 @@ on:
     - "**.m"
     - ".github/workflows/ci.yml"
 
+# avoid wasted runs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
 
@@ -15,7 +19,7 @@ jobs:
 
     strategy:
       matrix:
-        release: [R2020b, latest]
+        release: [R2020b, R2025a]
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/composite-buildtool/action.yml

@@ -7,15 +7,15 @@ runs:
   steps:
 
   - name: Run Matlab buildtool
-    if: ${{ matrix.release >= 'R2022b' || startsWith(matrix.release, 'latest') }}
+    if: ${{ matrix.release >= 'R2022b' }}
     uses: matlab-actions/run-build@v2
     with:
       startup-options: ${{ matrix.startup-options }}
       tasks: check test
 
 
   - name: Run tests (manual)
-    if: ${{ matrix.release < 'R2022b' && !startsWith(matrix.release, 'latest') }}
+    if: ${{ matrix.release < 'R2022b' }}
     uses: matlab-actions/run-tests@v2
     with:
       select-by-folder: test

.github/workflows/publish.yml

@@ -21,6 +21,7 @@ concurrency:
   group: "pages"
   cancel-in-progress: false
 
+
 jobs:
 
   deploy:
@@ -46,7 +47,10 @@ jobs:
       - name: Run Matlab buildtool
         uses: matlab-actions/run-build@v2
         with:
-          tasks: test publish
+          tasks: publish
+# don't run "test" task as then even "clean" will leave Matlab in cached state where
+# it won't publish due to thinking a function is a Mex file. Error is
+# "Error using publish Only MATLAB code can be published"
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

README.md

@@ -24,7 +24,7 @@ which means `import matmap3d` statements allow scoped use of this code.
 Optionally, run self-tests:
 
 ```matlab
-buildtool
+buildtool check test
 ```
 
 ### Functions

buildfile.m

@@ -1,42 +1,27 @@
 function plan = buildfile
 
-plan = buildplan();
+plan = buildplan(localfunctions);
 
 plan.DefaultTasks = "test";
 
 pkg_name = "+matmap3d";
 
-if isMATLABReleaseOlderThan("R2023b")
-  plan("test") = matlab.buildtool.Task(Actions=@legacy_test);
-else
-  plan("check") = matlab.buildtool.tasks.CodeIssuesTask(pkg_name, IncludeSubfolders=true, ...
-    WarningThreshold=0);
-  plan("test") = matlab.buildtool.tasks.TestTask("test", Strict=false);
-end
+plan("check") = matlab.buildtool.tasks.CodeIssuesTask(pkg_name, Results="CodeIssues.sarif", ...
+  IncludeSubfolders=true, WarningThreshold=0);
+plan("test") = matlab.buildtool.tasks.TestTask("test", TestResults="TestResults.xml", Strict=false);
 
 if ~isMATLABReleaseOlderThan("R2024a")
   plan("coverage") = matlab.buildtool.tasks.TestTask(Description="code coverage", SourceFiles="test", Strict=false, CodeCoverageResults="code-coverage.xml");
 end
 
-plan("publish") = matlab.buildtool.Task(Description="HTML inline doc generate", Actions=@publish_html);
-
-
-end
-
-
-function legacy_test(context)
-r = runtests(fullfile(context.Plan.RootFolder, "test"), Strict=false);
-% Parallel Computing Toolbox takes more time to startup than is worth it for this task
-
-assert(~isempty(r), "No tests were run")
-assertSuccess(r)
 end
 
 
-function publish_html(context)
-  outdir = fullfile(context.Plan.RootFolder, "docs");
+function publishTask(context)
+% publish HTML inline documentation strings to individual HTML files
+outdir = fullfile(context.Plan.RootFolder, 'docs');
 
-  publish_gen_index_html("matmap3d", ...
+publish_gen_index_html("matmap3d", ...
     "Geographic coordinate tranformation functions for Matlab.", ...
     "https://github.com/geospace-code/matmap3d", ...
     outdir)

private/publish_gen_index_html.m

@@ -12,10 +12,10 @@
 
 function publish_gen_index_html(pkg_name, tagline, project_url, outdir)
 arguments
-  pkg_name (1,1) string
-  tagline (1,1) string
-  project_url (1,1) string
-  outdir (1,1) string
+  pkg_name {mustBeTextScalar}
+  tagline {mustBeTextScalar}
+  project_url {mustBeTextScalar}
+  outdir {mustBeTextScalar}
 end
 
 pkg = what("+" + pkg_name);
@@ -24,7 +24,7 @@ function publish_gen_index_html(pkg_name, tagline, project_url, outdir)
 
 %% Git info
 repo = gitrepo(pkg.path);
-git_txt = "Git branch / commit: " + repo.CurrentBranch.Name + " " + extractBefore(repo.LastCommit.ID, 8);
+git_txt = "Git branch / commit: " + repo.CurrentBranch.Name + " " + repo.LastCommit.ID{1}(1:8);
 
 %% generate docs
 readme = fullfile(outdir, "index.html");