Updating to new structure

Author: eszmw

.github/workflows/release.yml

@@ -0,0 +1,108 @@
+# Release Fundamentals of Programming across all supported releases of MATLAB
+
+name: MATLAB Release
+
+# Run workflow when a tag is created
+on:
+  push:
+    tags: 
+      - 'v*'
+
+jobs:
+  # This workflow contains:
+  # 1. a matrixed test job run across a bunch of releases of MATLAB
+  # 2. a reporting job that summarizes the tests, and updates release badge
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        MATLABVersion: [R2020a, R2020b, R2021a, R2021b, R2022a, R2022b]
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+
+      - name: Set up MATLAB
+        uses: matlab-actions/setup-matlab@v1
+        with:
+          release: ${{ matrix.MATLABVersion }}
+
+      # Runs all tests in the project.  Put results in a version specific subdirectory
+      - name: Run tests
+        uses: matlab-actions/run-command@v1
+        with:
+          command: addpath("buildutil"),testToolbox('ReportSubdirectory',"${{ matrix.MATLABVersion }}")     
+
+      # Save the contents of the report directory from each release into a single artifact.  Since each release makes their own directory, they all update the same artifact.
+      - name: Save Report Directory
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: report
+          path: report
+          
+  # Report on what releases tested successfully.
+  # Generate a draft release based on the tag
+  # Recreate the tag with the final version of JSON files
+  release:
+    needs: test
+    if: always()
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v3
+        with:
+            ref: refs/heads/main
+    
+      - name: Set up MATLAB
+        uses: matlab-actions/setup-matlab@v1
+
+      # Copy all the reports down into the container
+      - uses: actions/download-artifact@v3
+        with:
+          name: report
+          path: report
+
+      # Generate the JSON for the releases tested badge
+      - name: Generate tested with badge
+        uses: matlab-actions/run-command@v1
+        with:
+          command: addpath("buildutil"),badgesforToolbox()     
+          
+      # Publish test results from all the releases
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          junit_files: "report/*/test-results.xml"    
+
+      # Commit the JSON for the MATLAB releases badge
+      - name: commit changed files
+        continue-on-error: true
+        run: |
+          git config user.name "${{ github.workflow }} by ${{ github.actor }}"
+          git config user.email "<>"
+          git commit report/badge/tested_with.json -m "Final checkins for release ${{  github.ref_name }}"
+          git fetch
+          git push
+
+      # Retag the repo so that the updated files are included in the release tag
+      - name: update tag
+        if: always()
+        continue-on-error: true
+        run: |
+          git config user.name "${{ github.workflow }} by ${{ github.actor }}"
+          git config user.email "<>"
+          git tag -d "${{  github.ref_name }}" 
+          git push --delete origin ${{  github.ref_name }}
+          git tag -m "Release ${{  github.ref_name }}" ${{  github.ref_name }}
+          git push --tag
+
+      # Create the release
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
+        with:
+          draft: true        
+          generateReleaseNotes: true

.gitignore

@@ -1,3 +1,55 @@
 # List of untracked files to ignore
 
-*.asv
+# Autosave files
+*.asv
+*.m~
+*.autosave
+*.slx.r*
+*.mdl.r*
+
+# MATLAB Drive
+*.MATLABDriveTag
+
+# Compiled files
+*.mex*
+*.p
+
+# Compressed files
+*.zip
+
+# Packaged app and toolbox files
+*.mlappinstall
+*.mltbx
+
+# Deployable archives
+*.ctf
+
+# Generated helpsearch folders
+helpsearch*/
+
+# Defined Simulink cache folder
+Utilities/SimulinkCache/*
+
+# Standard code generation folders
+slprj/
+sccprj/
+codegen/
+
+# Code generation file
+*.eep
+*.elf
+*.hex
+*.bin
+
+# Cache files
+*.slxc
+
+# Project settings
+Utilities/ProjectSettings.mat
+
+# Test results
+SoftwareTests/TestResults_*
+
+# Auto-generated from Scripts
+*/*/MyFavoriteChaosGameImage.png
+*/*/fileInfo.txt

.gitlab-ci.yaml

@@ -0,0 +1,9 @@
+stages:         
+  - test
+
+matlab-test-job:   
+  tags: 
+    - matlab
+  stage: test
+  script:
+    - matlab -batch "openProject('FundamentalsofProgramming.prj'); results = runtests('IncludeSubfolders', true); disp(table(results)); assertSuccess(results);"

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® 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® 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!**

CollectedProTips.mlx

@@ -1,17 +1,17 @@
 % Initialize values for a randomly chosen starting point
-startingPoint = rand([1 2]);
+StartingPoint = rand([1 2]);
 % Set the number of additional points to add
-numPts = 100;
+NumPts = 100;
 % Initialize a variable to track the previous vertex.
-oldVertex = 0;
+OldVertex = 0;
 % Initialize a vector of point values of the appropriate size
 % For a large number of iterations, this is much more efficient than
 % adding a new point to the end at each step which requires reallocating
 % memory for a different size array each time
-startingVals = startingPoint.*ones([numPts 1]);
+StartingVals = StartingPoint.*ones([NumPts 1]);
 % Graph a scatter plot of the first point and save a handle to 
 % the scatter plot object for future reference
-s = scatter(startingVals(:,1),startingVals(:,2),".");
+s = scatter(StartingVals(:,1),StartingVals(:,2),".");
 % Set the x and y limits on the plot
 xlim([0 1])
 ylim([0 1])
@@ -22,28 +22,28 @@
 % Exercise 5 code goes here
 
 % Implement the chaos game. 
-for k = 1:numPts
-    newVertex = randi(4,1);
+for k = 1:NumPts
+    NewVertex = randi(4,1);
 %         Exercise 4 code goes here
-    switch newVertex
+    switch NewVertex
         case 1
-            newCoords = [0 0];
+            NewCoords = [0 0];
         case 2
-            newCoords = [0 1];
+            NewCoords = [0 1];
         case 3
-            newCoords = [1 1];
+            NewCoords = [1 1];
         case 4
-            newCoords = [1 0];
+            NewCoords = [1 0];
     end
     % Update the new point using the formula from the rules of the game
-    % This does simplify to (newCoords+startingPoint)/2 as used in the live
+    % This does simplify to (NewCoords+StartingPoint)/2 as used in the live
     % script
-    newPoint = (newCoords-startingPoint)/2 + startingPoint;
+    NewPoint = (NewCoords-StartingPoint)/2 + StartingPoint;
 
-    s.XData(k) = newPoint(1);
-    s.YData(k) = newPoint(2);
-    startingPoint = newPoint;
-    oldVertex = newVertex;
+    s.XData(k) = NewPoint(1);
+    s.YData(k) = NewPoint(2);
+    StartingPoint = NewPoint;
+    OldVertex = NewVertex;
 % Exercise 3 code goes here
     drawnow
 % Exercise 3 code goes here, too