Update module structure

MathWorks-Teaching-Resources · Oct 27, 2023 · 29ff234 · 29ff234
1 parent 68750b4
commit 29ff234
Show file tree

Hide file tree

Showing 116 changed files with 870 additions and 61 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -5,10 +5,10 @@
 *.mexa64 binary
 *.mexw64 binary
 *.mexmaci64 binary
-*.mlapp binary linguist-language=MATLAB
+*.mlapp binary
 *.mldatx binary
 *.mlproj binary
-*.mlx binary merge=mlAutoMerge linguist-language=MATLAB
+*.mlx binary
 *.p binary
 *.sfx binary
 *.sldd binary
@@ -26,7 +26,3 @@
 *.pdf binary
 *.png binary
 *.xlsx binary
-
-# Ignore HTML
-
-*.html linguist-detectable=false
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -0,0 +1,85 @@
+stages:         
+# Set up two testing paths
+  - setup
+  - test
+  - release
+
+setup-job:
+    tags:
+      - matlab
+    stage: setup
+    script:
+      - cd ..
+      - if (test-path utilities) { rm -r -force utilities }
+      - git clone [email protected]:modular-curriculum-content/utilities.git
+      - cd $CI_PROJECT_NAME 
+    allow_failure: false
+
+
+smoke-test:
+# Smoke tests should run all the time
+    tags:
+    # Add additional tags like (e.g. - arduino) as required
+    # Make sure that the runner you plan to use matches the tags
+      - matlab
+    stage: test
+    script: 
+      - matlab -batch "openProject(pwd); 
+        results = runtests(fullfile('SoftwareTests','SmokeTests.m'));
+        disp(table(results)); assertSuccess(results);"
+    when: always
+    allow_failure: true
+
+smoke-test-solution:
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        addpath(genpath(proj.RootFolder));
+        results = runtests(fullfile('InternalFiles','Tests','CI','SolnSmokeTests.m'));
+        disp(table(results)); assertSuccess(results);"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true
+
+file-test:   
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        addpath(proj.RootFolder+'/InternalFiles/Tests/CI');
+        results = runtests('OpenCloseFileTest.m');
+        disp(table(results)); assertSuccess(results);"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true
+
+release-testing:
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        cd ..;
+        addpath(genpath(fullfile('utilities','TestingResources')));
+        runCMTests"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Contributing
+
+>_If you believe you have discovered a security vulnerability, please **do not** open an issue or make a pull request.  Follow the instructions in the [SECURITY.md](SECURITY.md) file in this repository._
+
+Thank you for your interest in contributing to a MathWorks repository!  We encourage contributions large and small to this repository.  
+
+**Contributions do not have to be code!** If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content).  We welcome issues even if you don't code the solution.  We also welcome pull requests to resolve issues that we haven't gotten to yet!
+
+## How to give feedback
+* **Send us an email:**  Contact the [MathWorks teaching resources team.](mailto:[email protected])
+* **Open an issue:** Start by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) in the repository that you're interested in.  That will start a conversation with the maintainer.  When you are creating a bug report, please include as many details as possible.  Please remember that other people do not have your background or understanding of the issue; make sure you are clear and complete in your description.
+
+## How to contribute to the repository
+* **Work in your own public fork:** If you choose to make a contribution, you should [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).  This creates an editable copy on GitHub where you can write, test, and refine your changes.  We suggest that you keep your changes small and focused on the issue you submitted.
+* **Sign a Contributor License Agreement (CLA):** We require that all outside contributors sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) before we can accept your contribution.  When you create a pull request (see below), we'll reach out to you if you do not already have one on file.  Essentially, the CLA gives us permission to publish your contribution as part of the repository.
+* **Make a pull request:** "[Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" is a confusing term, but it means exactly what it says:  You're requesting that the maintainers of the repository pull your changes in.  If you don't have a CLA on file, we'll reach out to you.  Your contribution will be reviewed, and we may ask you to revise your pull request based on our feedback.  Once everyone is satisfied, we'll merge your pull request into the repository.
+
+## Guidelines
+
+We don't have best practices for writing MATLAB&reg; code, but we do have some recommendations:
+
+* You should not have any warnings or errors in the [code analyzer report](http://www.mathworks.com/help/matlab/matlab_prog/matlab-code-analyzer-report.html)
+* [Loren Shure's blog](https://blogs.mathworks.com/loren) has [great advice on improving your MATLAB code](https://blogs.mathworks.com/loren/category/best-practice/)
+* Examples should be written as [live scripts](https://www.mathworks.com/help/matlab/matlab_prog/what-is-a-live-script-or-function.html) or [Simulink&reg; models](https://www.mathworks.com/help/simulink/index.html).
+* We adhere to the [CommonMark](https://commonmark.org/) specification where it does not conflict with GitHub rendering.  If you edit your Markdown in Visual Studio Code or a similar editor, it uses [markdownlint](https://github.com/DavidAnson/markdownlint) to highlight issues in your Markdown.
+
+**Again, thanks for contributing, and we look forward to your issues and pull requests!**
diff --git a/Images/image_0.png b/Images/image_0.png
diff --git a/Images/image_1.png b/Images/image_1.png
diff --git a/Images/image_10.png b/Images/image_10.png
diff --git a/Images/image_11.png b/Images/image_11.png
diff --git a/Images/image_12.png b/Images/image_12.png
diff --git a/Images/image_13.png b/Images/image_13.png
diff --git a/Images/image_2.png b/Images/image_2.png
diff --git a/Images/image_3.png b/Images/image_3.png
diff --git a/Images/image_4.png b/Images/image_4.png
diff --git a/Images/image_5.png b/Images/image_5.png
diff --git a/Images/image_6.png b/Images/image_6.png
diff --git a/Images/image_7.png b/Images/image_7.png
diff --git a/Images/image_8.png b/Images/image_8.png
diff --git a/Images/image_9.png b/Images/image_9.png
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,27 @@
+Copyright (c) 2023, The MathWorks, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in
+      the documentation and/or other materials provided with the distribution
+    * Neither the name of the The MathWorks, Inc. nor the names
+      of its contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/License.txt b/License.txt
diff --git a/MainMenu.mlx b/MainMenu.mlx