publish Git info

functionalize publish
geospace-code · Nov 19, 2024 · 8a4dd4f · 8a4dd4f
1 parent 01cfa5c
commit 8a4dd4f
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 86 deletions.
diff --git a/buildfile.m b/buildfile.m
@@ -4,104 +4,30 @@
 plan("test").Dependencies = "check";
 end
 
-
 function checkTask(~)
 % Identify code issues (recursively all Matlab .m files)
 issues = codeIssues;
 assert(isempty(issues.Issues), formattedDisplayText(issues.Issues))
 end
 
-
 function testTask(~)
-r = runtests('test/', strict=true, UseParallel=false);
-% UseParallel can be a lot slower, especially on Mac
-assert(~isempty(r), "No tests were run")
-assertSuccess(r)
-end
+  r = runtests(IncludeSubfolders=true, strict=true, UseParallel=true);
 
+  assert(~isempty(r), "No tests were run")
+  assertSuccess(r)
+end
 
 function coverageTask(~)
-import matlab.unittest.TestRunner
-import matlab.unittest.Verbosity
-import matlab.unittest.plugins.CodeCoveragePlugin
-% import matlab.unittest.plugins.XMLPlugin
-% import matlab.unittest.plugins.codecoverage.CoberturaFormat
-
-
-pkg = "stdlib";
-
-suite = testsuite("test/");
-
-% not import to allow use of rest of buildfile with R2022b
-format = matlab.unittest.plugins.codecoverage.CoverageResult;
-
-
-runner = TestRunner.withTextOutput();
-runner.addPlugin(...
-  CodeCoveragePlugin.forPackage(pkg, ...
-    IncludingSubpackages=true, Producing=format))
-
-% runner.addPlugin(XMLPlugin.producingJUnitFormat('test-results.xml'))
-% runner.addPlugin(CodeCoveragePlugin.forPackage(pkg, 'Producing', ...
-%     CoberturaFormat('test-coverage.xml')))
-
-run_results = runner.run(suite);
-assert(~isempty(run_results), "no tests found")
+  cwd = fileparts(mfilename('fullpath'));
 
-assertSuccess(run_results)
-
-generateHTMLReport(format.Result)
+  coverage_run("stdlib", fullfile(cwd, "test"))
 end
 
-
 function publishTask(~)
-% publish (generate) docs from Matlab project
-% https://www.mathworks.com/help/matlab/ref/publish.html
-% https://www.mathworks.com/help/matlab/matlab_prog/marking-up-matlab-comments-for-publishing.html
-%
-% for package code -- assumes no classes and depth == 1
-pkg_name = "stdlib";
-
-pkg = what(pkg_name);
-
-%% generate docs
-cwd = fileparts(mfilename('fullpath'));
-docs = fullfile(cwd, "docs");
-readme = fullfile(docs, "index.html");
-
-if ~isfolder(docs)
-  mkdir(docs);
-end
-
-txt = ["<!DOCTYPE html> <head> <title>Standard library for Matlab API</title> <body>", ...
-       "<h1>stdlib for Matlab API</h1>", ...
-       "A standard library of functions for Matlab.", ...
-       "<h2>API Reference</h2>"];
-fid = fopen(readme, 'w');
-fprintf(fid, join(txt, "\n"));
-
-for sub = pkg.m.'
-  s = sub{1};
-  [~, name] = fileparts(s);
-  doc_fn = publish(pkg_name + "." + name, evalCode=false, outputDir=docs);
-  disp(doc_fn)
-  % inject summary into Readme.md
-  summary = split(string(help(pkg_name + "." + name)), newline);
-  words = split(strip(summary(1)), " ");
-  % purposefully this will error if no docstring
-  fname = words(1);
-  if(lower(fname) ~= lower(name))
-    error("fname %s does not match name %s", fname, name)
-  end
-  line = "<a href=" + name + ".html>" + fname + "</a> ";
-  if(length(words) > 1)
-    line = line + join(words(2:end));
-  end
-  fprintf(fid, line + "<br>\n");
-end
-
-fprintf(fid, "</body> </html>");
-
-fclose(fid);
+  cwd = fileparts(mfilename('fullpath'));
+  outdir = fullfile(cwd, "docs");
 
+  publish_gen_index_html("stdlib", ...
+    "A standard library of functions for Matlab.", ...
+    outdir)
 end
diff --git a/private/publish_gen_index_html.m b/private/publish_gen_index_html.m
@@ -13,6 +13,10 @@ function publish_gen_index_html(pkg_name, tagline, outdir)
 % "+" avoids picking up cwd of same name
 assert(~isempty(pkg), pkg_name + " is not detected as a Matlab directory or package")
 
+%% Git info
+repo = gitrepo(pkg.path);
+git_txt = "Git branch / commit: " + repo.CurrentBranch.Name + " " + extractBefore(repo.LastCommit.ID, 8);
+
 %% generate docs
 readme = fullfile(outdir, "index.html");
 
@@ -22,7 +26,8 @@ function publish_gen_index_html(pkg_name, tagline, outdir)
 
 txt = ["<!DOCTYPE html> <head> <title>" + pkg_name + " API</title> <body>", ...
      "<h1>" + pkg_name + " API</h1>", ...
-     tagline, ...
+     "<p>" + tagline + "</p>", ...
+     "<p>" + git_txt + "</p>", ...
      "<h2>API Reference</h2>"];
 fid = fopen(readme, 'w');
 fprintf(fid, join(txt, "\n"));