Add checkcode GitHub Action

.github/README.md

@@ -1,12 +1,22 @@
 # matlab-project-template
-This is a template repository you can use for your MATLAB software project. It pre-populates essential files and directory structure when you use this template to create the repository for your project.
+
+This is a template repository you can use for your MATLAB software project. It
+pre-populates essential files and directory structure when you use this template
+to create the repository for your project.
 
 ## Getting started
-Click **Use this template**, then select **Create a new repository** and then fill in the essential information for your repository. Then a repository that utilises this template will be created for you.
-More detailed instructions can be found [here]('https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template').
+
+Click **Use this template**, then select **Create a new repository** and then
+fill in the essential information for your repository. Then a repository that
+utilises this template will be created for you. More detailed instructions can
+be found
+[here]('https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template').
 
 ## After the repository has been created
-You will need to make changes to some of the placeholder content in the files in your new repository. See more instructions in the README file in the new repository.
+
+You will need to make changes to some of the placeholder content in the files in
+your new repository. See more instructions in the README file in the new
+repository.
 
 [![Test](https://github.com/reproducibleMATLAB/matlab-project-template/actions/workflows/test.yaml/badge.svg)](https://github.com/reproducibleMATLAB/matlab-project-template/actions/workflows/test.yaml)
 

.github/workflows/checkcode.yaml

@@ -0,0 +1,49 @@
+---
+name: Checkcode
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  cancel-in-progress: true
+  group: >-
+    ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+
+jobs:
+  directories:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Get directories
+        id: directories
+        run: >-
+          echo directories=$(find . -type d -mindepth 1 -not -path '*/\.*' | sed
+          's/^..//' | jq -R -s -c 'split("\n")[:-1]') >> $GITHUB_OUTPUT
+    outputs:
+      directories: ${{ steps.directories.outputs.directories }}
+
+  checkcode:
+    needs: directories
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        directory: ${{ fromJson(needs.directories.outputs.directories) }}
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Set up MATLAB
+        uses: matlab-actions/setup-matlab@v2
+
+      - name: Move into ${{ matrix.directory }} directory
+        run: cd ${{ github.workspace }}/${{ matrix.directory }}
+
+      - name: Run MATLAB Command
+        uses: matlab-actions/run-command@v2
+        with:
+          command: mlintrpt

README.md

@@ -1,6 +1,6 @@
 # PROJECT-NAME
-(Add one line summary of what it does)
 
+(Add one line summary of what it does)
 
 ## TODO Upon Project Creation
 
@@ -20,21 +20,24 @@
 
 First, clone this repository:
 
-```
-# Clone this repository
+```sh
 git clone https://github.com/<username>/<PROJECT-NAME>.git
 cd <PROJECT-NAME>
 ```
-Alternatively, download the code as a .zip folder by clicking the "Code" button on GitHub.
 
+Alternatively, download the code as a .zip folder by clicking the "Code" button
+on GitHub.
 
 ## Contributing
 
-<PROJECT-NAME> is an open-source project and we welcome contributions from the community.
+<PROJECT-NAME> is an open-source <!-- markdownlint-disable-line MD033 -->
+project, and we welcome contributions from the community.
 
-If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
+If you'd like to contribute, please fork the repository and make changes as
+you'd like. Pull requests are warmly welcome.
 
 ### Our Contributors
+
 <a href="https://github.com/reproducibleMATLAB/matlab-project-template/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=reproducibleMATLAB/matlab-project-template" />
 </a>

tests/source/scripts/main.m

@@ -2,4 +2,4 @@
 
 function out = main(variable)
     % your code here %
-end
+end

tests/source/scripts/mainRun.m

@@ -1,2 +1,2 @@
 % Execute the runtests function to run the four tests in main.m
-results = runtests('main');
+results = runtests('main');

tests/source/scripts/mainTest.m

@@ -3,4 +3,3 @@
 
 % This unit test can use assert to check different outputs of main
 % function
-