Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
92 commits
Select commit Hold shift + click to select a range
73d6346
Add cmark-gfm MEX binary
djmsampson Oct 31, 2026
79bbbda
Add cmark-gfm converter adapter
djmsampson Oct 31, 2026
1839a38
Make cmark-gfm the only converter
djmsampson Oct 31, 2026
7cda479
Use SemVer in documentation version references
djmsampson Oct 31, 2026
12cdd89
Remove standalone conversion documentation
djmsampson Oct 31, 2026
e1bac63
Document cmark-gfm and gemoji dependencies
djmsampson Oct 31, 2026
835e128
Add pinned cmark-gfm and gemoji submodules
djmsampson Oct 31, 2026
c86be07
Track submodule metadata in MATLAB project
djmsampson Oct 31, 2026
69195e2
Add cmark-gfm MEX source to MATLAB project
djmsampson Oct 31, 2026
8bae3c4
Build cmark-gfm MEX with buildtool
djmsampson Oct 31, 2026
bd22e31
Template generated cmark-gfm emoji map
djmsampson Oct 31, 2026
fef761b
Rename vendor submodules directory to ext
djmsampson Nov 1, 2026
f8daf54
Refresh MATLAB project source control before checks
djmsampson Nov 1, 2026
4e97aa3
Run buildtool tests in CI
djmsampson Nov 1, 2026
44e572c
Document build tasks and refresh project status
djmsampson Nov 1, 2026
2642d79
Clarify MEX build inputs
djmsampson Nov 1, 2026
e093b53
Document build helpers and clarify generated outputs
djmsampson Nov 1, 2026
0d60800
Document local Markdown renderer workflow
djmsampson Nov 1, 2026
ed33170
Update project and toolbox documentation
djmsampson Nov 2, 2026
922046a
Ship native dependency notices with MEX
djmsampson Nov 2, 2026
eb1c4d7
Ignore generated MEX rights files
djmsampson Nov 2, 2026
f5f28ae
Document multi-platform MEX support
djmsampson Nov 3, 2026
1bb6b5d
Limit release checks to version tags
djmsampson Nov 3, 2026
8032ca3
Configure multi-platform MEX CI
djmsampson Nov 3, 2026
c3a0aa9
Run CI on the multiplatform branch
djmsampson Nov 3, 2026
a67aff2
Build native MEX before platform checks
djmsampson Nov 3, 2026
de5433e
Skip project checks in Windows MEX matrix
djmsampson Nov 3, 2026
65f672f
Order CI checks and platform builds
djmsampson Nov 3, 2026
ab448b6
Use runtests for Windows release matrix
djmsampson Nov 3, 2026
b3ce0ec
Park macOS CI jobs
djmsampson Nov 3, 2026
3cdf27e
Allow filtered tests in CI
djmsampson Nov 3, 2026
a85fbac
Build docs on Windows in CI
djmsampson Nov 3, 2026
2aca527
Name CI artifacts by file type
djmsampson Nov 3, 2026
71ceadd
Run release matrix tests on Linux
djmsampson Nov 3, 2026
ad7ec31
Track latest MATLAB release in CI
djmsampson Nov 3, 2026
f2b0f0c
Simplify CI test setup
djmsampson Nov 3, 2026
e4b00b4
Enable Apple Silicon CI build
djmsampson Nov 3, 2026
b69106e
Add Intel macOS R2025b build
djmsampson Nov 3, 2026
fe26288
Refactor CI workflows
djmsampson Nov 12, 2026
44b0f0a
Run mini CI on cmark_multiplatform
djmsampson Nov 12, 2026
95c2489
Add CI files to MATLAB project
djmsampson Nov 12, 2026
0d70869
Run platform tests on cmark_multiplatform
djmsampson Nov 12, 2026
4d813cb
Test older MATLAB releases on cmark branch
djmsampson Nov 12, 2026
094f386
Keep task test loadable before R2022b
djmsampson Nov 12, 2026
41cbb01
Restore task property label
djmsampson Nov 13, 2026
0a60c38
Add MathWorks copyrights to MATLAB files
djmsampson Nov 13, 2026
f1694ff
Add copyrights to first-party source files
djmsampson Nov 13, 2026
e06e716
Test platform MEX builds before branch packaging
djmsampson Nov 13, 2026
f051001
Rename platform test job
djmsampson Nov 13, 2026
c664a53
Keep emoji template marker unique
djmsampson Nov 13, 2026
1a979ca
Refine CI MEX artifact flow
djmsampson Nov 13, 2026
93410c2
Parallelize full MATLAB CI suites
djmsampson Nov 13, 2026
49e117b
Remove obsolete cmark workflow paths
djmsampson Nov 13, 2026
4d3589a
Remove deleted branch from CI docs
djmsampson Nov 13, 2026
9a7cbd2
Support draft releases and semver notes
djmsampson Nov 13, 2026
39fcc3e
Require stable versions for published releases
djmsampson Nov 13, 2026
0f80811
Add optional GitHub Markdown renderer
djmsampson Nov 14, 2026
e22de21
Add final newlines to MATLAB files
djmsampson Nov 14, 2026
008e7e6
Add final newlines to Markdown files
djmsampson Nov 14, 2026
4673668
Add final newlines to remaining text files
djmsampson Nov 14, 2026
a8c390c
Match MATLAB function help style
djmsampson Nov 14, 2026
5e69cce
Inline DocMaker root lookup
djmsampson Nov 14, 2026
8c51f56
Use converter terminology for Markdown HTML
djmsampson Nov 14, 2026
2a06cd6
Name the cmark Markdown converter
djmsampson Nov 14, 2026
9eecf3b
Clarify docconvert converter documentation
djmsampson Nov 14, 2026
63f171c
Add Markdown conversion guide
djmsampson Nov 14, 2026
8eabcf9
Update MATLAB project metadata
djmsampson Nov 14, 2026
9dbe27e
Simplify docconvert option validation
djmsampson Nov 14, 2026
9e37295
Add converter option to documentation indexing
djmsampson Nov 14, 2026
9ebb2bb
Update Markdown converter documentation
djmsampson Nov 14, 2026
f134ec1
Reorder documentation footer links
djmsampson Nov 14, 2026
e0d7dc6
Use compatible MATLAB argument blocks
djmsampson Nov 14, 2026
a092595
Clarify self-closing tag help
djmsampson Nov 14, 2026
d471606
Mark old search index tests incomplete
djmsampson Nov 14, 2026
7108ff1
Add docindex converter completion
djmsampson Nov 14, 2026
d7f0ba6
Updated release date
djmsampson Nov 14, 2026
fc801cf
Removed hard wrapping from Markdown source
djmsampson Nov 14, 2026
b720c7b
Use single spaces between Markdown sentences
djmsampson Nov 14, 2026
de78e62
Match test class help capitalization
djmsampson Nov 14, 2026
79af4d3
Set license in package task, closes #42
djmsampson Nov 18, 2026
dd81c2e
Update BSD license notices
djmsampson Nov 18, 2026
eea3761
Update toolbox author company
djmsampson Nov 18, 2026
d84d1e4
Add GitLab Markdown converter
djmsampson Nov 19, 2026
0278bc6
Document GitLab Markdown conversion
djmsampson Nov 19, 2026
98dce5b
Rename converters to md2html
djmsampson Nov 19, 2026
134fa30
Use lowercase names in converter help
djmsampson Nov 19, 2026
ed34877
Qualify package names in inline help
djmsampson Nov 19, 2026
12e75be
Clarify hosted API inline help
djmsampson Nov 19, 2026
5ef3239
Add colons to See also help references
djmsampson Nov 19, 2026
b616210
Split GitLab DOM cleanup from HTML parsing
djmsampson Nov 19, 2026
6baf4b9
Clarify GitLab DOM cleanup sections
djmsampson Nov 19, 2026
9afade7
Update CI for renamed cmark MEX
djmsampson Nov 19, 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
84 changes: 84 additions & 0 deletions .github/workflows/build-mex.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Build MATLAB MEX

on:
workflow_call:
inputs:
runner:
description: GitHub Actions runner label
required: true
type: string
source_ref:
description: Repository ref to build
required: false
default: ''
type: string
release:
description: MATLAB release to use
required: true
type: string
mex_extension:
description: Expected MATLAB MEX extension, without a leading dot
required: true
type: string
artifact_name:
description: Optional artifact name; defaults to the MEX extension
required: false
default: ''
type: string
architecture:
description: Expected runner architecture, or skip
required: false
default: skip
type: string
run_tests:
description: Run the complete toolbox test suite after building
required: false
default: true
type: boolean

permissions:
contents: read

jobs:
build:
runs-on: ${{ inputs.runner }}
steps:
- name: Check out the repository
uses: actions/checkout@v6
with:
ref: ${{ inputs.source_ref || github.ref }}
submodules: recursive

- name: Verify runner architecture
if: ${{ inputs.architecture != 'skip' }}
shell: bash
run: test "$(uname -m)" = "${{ inputs.architecture }}"

- name: Set up MATLAB
uses: matlab-actions/setup-matlab@v3
with:
products: MATLAB
release: ${{ inputs.release }}

- name: Configure the C compiler
uses: matlab-actions/run-command@v3
with:
command: mex -setup C

- name: Build MEX
uses: matlab-actions/run-command@v3
with:
command: openProject(pwd); buildtool('mex')

- name: Run the full test suite
if: ${{ inputs.run_tests }}
uses: matlab-actions/run-command@v3
with:
command: openProject(pwd); buildtool('test')

- name: Upload MEX artifact
uses: actions/upload-artifact@v4
with:
name: ${{ inputs.artifact_name || inputs.mex_extension }}
path: tbx/docmaker/+docmaker/cmarkmd2html.${{ inputs.mex_extension }}
if-no-files-found: error
29 changes: 29 additions & 0 deletions .github/workflows/docmaker-ci.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# CI workflows

`docmaker-ci.yml` is the primary workflow. It selects `test-mini`, `test-full`, toolbox packaging, or a draft GitHub release based on the GitHub event or a manually selected mode.

## Modes and triggers

| Mode | Trigger | Work performed |
| --- | --- | --- |
| `test-mini` | Pull requests not targeting `master`; pushes to `master`; manual selection | Ubuntu 24.04 with the latest MATLAB builds and tests the Linux MEX. |
| `test-full` | Pull requests targeting `master`; manual selection | Builds and tests the latest Linux MEX and Windows/Mac MEX files. Linux compatibility tests run on R2021a, R2022b, R2023b, R2024b, and R2025b using the latest Linux MEX. The compatibility matrix can run alongside the Windows/Mac tests. |
| Package | Push of a `vMAJOR.MINOR.PATCH` tag reachable from `master`; manual selection | Builds Windows and Mac MEX files, stages them on Linux, then runs `buildtool('package')`. A valid tag publishes the MLTBX as a GitHub Release; manual runs upload it as a 14-day workflow artifact. |
| Draft | Manual selection | Builds and tests the MEX files, packages the toolbox, and creates a GitHub draft release tagged from the toolbox version in `Contents.m`. It does not run the tag ancestry check or publish to File Exchange. |

For a master-targeted pull request, `test-linux-latest` and the Windows/Mac `test-platforms-latest` matrix run concurrently. `test-linux-releases` starts after the Linux latest MEX artifact is available, so it can overlap the Windows/Mac tests. Intel Mac uses MATLAB R2025b; Windows and Apple Silicon use `latest`. Linux compatibility jobs use Ubuntu 22.04 for R2021a, R2022b, and R2023b, and Ubuntu 24.04 for R2024b and R2025b. R2021a is best-effort on Ubuntu 22.04 because its newest officially supported Ubuntu release, 20.04, is no longer available as a GitHub-hosted runner.

In the Actions job list, `test-mini` runs as `test-linux-latest`. Manual `test-full` runs `test-linux-latest` and `test-platforms-latest` concurrently, with `test-linux-releases` depending only on `test-linux-latest`. Tag packaging uses `check-tag`, `mex`, `package`, and `publish` in sequence.

Manual runs use the `mode` selector (`test-mini`, `test-full`, `package`, or `draft`) and the ref selected in the Actions UI. The `docmaker-ci.yml` workflow must first be merged into the default branch (`master`) before GitHub exposes it there for manual dispatch.

## Package flow

The reusable `build-mex.yml` workflow compiles and tests each native MEX and uploads it as an artifact. The Ubuntu 24.04 package job checks out the selected source, downloads the Windows and Mac artifacts, stages them in `tbx/docmaker/+docmaker`, and runs `buildtool('package')`. That build task creates the Linux MEX and runs its check, test, and documentation dependencies before packaging. CI checks that the resulting MLTBX contains all four platform MEX files.

The manual `draft` mode uses that package artifact to create a GitHub draft release. It reads the toolbox version from `tbx/docmaker/Contents.m` to form the release tag. Draft releases support prerelease and build versions: their tag and title keep the full version, while release notes use the matching `MAJOR.MINOR.PATCH` changelog section. Automatic publishing accepts only plain `vMAJOR.MINOR.PATCH` tags. The draft job does not run `check-tag`; the normal tag-push publish flow retains that gate.

MEX artifacts use their extensions as names: `mexa64`, `mexw64`, `mexmaci64`, and `mexmaca64`. The toolbox artifact is named `mltbx`.

For tag-push releases, `check-tag` requires the exact `vMAJOR.MINOR.PATCH` format and verifies that the commit is reachable from `master` before MEX builds and packaging begin. The package task also checks that the toolbox version matches the tag. The GitHub Release uses the corresponding `MAJOR.MINOR.PATCH` section from `tbx/docmakerdoc/changelog.md`.

Loading
Loading