diff --git a/WorkshopGuide.m b/WorkshopGuide.m index 14392b1..a6a1eda 100644 --- a/WorkshopGuide.m +++ b/WorkshopGuide.m @@ -177,11 +177,11 @@ %[text] **Interactively test** [**`SimulationModel`**](file:.\code\SimulationModel.m) **using the MATLAB Command Window** %[text] Here's an example code you can run at the Command Window: %[text] ```matlabCodeExample -%[text] >> sObj = SimulationModel; -%[text] >> simulate(sObj); -%[text] >> sbioplot(sObj.SimData); -%[text] >> isa(sObj.SimData, 'SimData') -%[text] >> all(ismember(sObj.SimData.DataNames,["Drug","Receptor","Complex","RO"])) +%[text] sObj = SimulationModel; +%[text] simulate(sObj); +%[text] sbioplot(sObj.SimData); +%[text] isa(sObj.SimData, 'SimData') +%[text] all(ismember(sObj.SimData.DataNames,["Drug","Receptor","Complex","RO"])) %[text] ``` %[text] %[text] ![](text:image:62b1) @@ -708,7 +708,7 @@ %% %[text] ## Part 6: Compile the App in the CI workflow and download the artifact %[text] -%[text] So far, we have only triggered tests and generated reports/badges. We were able to use free github runner and licensing in our public repo. +%[text] So far, we have only triggered tests and generated reports/badges. We were able to use free GitHub runner and licensing in our public repo. %[text] However, our final goal is to compile our app into a web app. For this we will need a license of MATLAB Compiler. This will be provided by a BATCH TOKEN. %[text] In this section, you will: %[text] 1. Add a batch token to your repository @@ -755,8 +755,7 @@ %[text] **Part 6.3: Download the resulting CTF file** %[text] Once the `Deploy/ Release (main)` job is done, a new artifact is available at the bottom of the run page: %[text] ![](text:image:71f2) -%[text] You can now download the CTF file and upload it to your Web App Server using your github username and the password `BMS2026` -%[text] [https://vdi-wd1ah2-348.dhcp.mathworks.com:9999/webapps/home/login.html](https://vdi-wd1ah2-348.dhcp.mathworks.com:9999/webapps/home/login.html) +%[text] You can now download the CTF file and upload it to your Web App Server! %[text] %% %[text] ## Workshop wrap-up and additional information diff --git a/WorkshopGuide.md b/WorkshopGuide.md index ae5b0a8..117005f 100644 --- a/WorkshopGuide.md +++ b/WorkshopGuide.md @@ -19,19 +19,19 @@ In this workshop, you will: ## Table of Contents  [Workshop Requirements](#H_34C2FB57) - [Part 1: Getting the workshop files and configuring GitHub for automated testing and results publishing](#TMP_95f1) + [Part 1: Getting the workshop files and configuring GitHub for automated testing and results publishing](#TMP_569f) - [Part 2: Generating your first tests](#TMP_080d) + [Part 2: Generating your first tests](#TMP_6930) - [Part 3: Finding existing tests and measuring coverage](#TMP_247c) + [Part 3: Finding existing tests and measuring coverage](#TMP_50f4) - [Part 4: Updating badges, committing our changes, and pushing to GitHub](#TMP_0c93) + [Part 4: Updating badges, committing our changes, and pushing to GitHub](#TMP_5540) - [Part 5: Create a pull request, watch GitHub Actions automatically test your changes and publish results](#TMP_1f7d) + [Part 5: Create a pull request, watch GitHub Actions automatically test your changes and publish results](#TMP_3054) - [Part 6: Compile the App in the CI workflow and download the artifact](#TMP_2778) + [Part 6: Compile the App in the CI workflow and download the artifact](#TMP_1fc1) - [Workshop wrap\-up and additional information](#TMP_8fab) + [Workshop wrap\-up and additional information](#TMP_225a) @@ -56,7 +56,7 @@ The following steps cover all of the things you will need to successfully comple - The workshop leverages the free repository and CI capabilities offered by GitHub and GitHub Actions - Go to: [**https://github.com/signup**](https://github.com/signup) - + # Part 1: Getting the workshop files and configuring GitHub for automated testing and results publishing @@ -308,7 +308,7 @@ Click on the 'Run App' shortcut to start the app in MATLAB: ![image_20.png](WorkshopGuide_media/image_20.png) - + # Part 2: Generating your first tests @@ -336,11 +336,11 @@ edit SimulationModel.m Here's an example code you can run at the Command Window: ``` ->> sObj = SimulationModel; ->> simulate(sObj); ->> sbioplot(sObj.SimData); ->> isa(sObj.SimData, 'SimData') ->> all(ismember(sObj.SimData.DataNames,["Drug","Receptor","Complex","RO"])) +sObj = SimulationModel; +simulate(sObj); +sbioplot(sObj.SimData); +isa(sObj.SimData, 'SimData') +all(ismember(sObj.SimData.DataNames,["Drug","Receptor","Complex","RO"])) ``` ![image_21.png](WorkshopGuide_media/image_21.png) @@ -529,7 +529,7 @@ Congratulations! You just created multiple tests for your MATLAB code! It was easier than you thought, right? - + # Part 3: Finding existing tests and measuring coverage @@ -868,7 +868,7 @@ It looks like we've achieved full statement coverage for [`generateSimFun`](./co ![image_65.png](WorkshopGuide_media/image_65.png) - + # Part 4: Updating badges, committing our changes, and pushing to GitHub @@ -1088,7 +1088,7 @@ At this point, all of your changes will be pushed to GitHub. ![image_85.png](WorkshopGuide_media/image_85.png) - + # Part 5: Create a pull request, watch GitHub Actions automatically test your changes and publish results @@ -1249,11 +1249,11 @@ The code coverage report looks like this: Now anyone that visits your repository can immediately see the quality of your code, explore your test and code coverage results, and will have more confidence in the code you are writing! - + # Part 6: Compile the App in the CI workflow and download the artifact -So far, we have only triggered tests and generated reports/badges. We were able to use free github runner and licensing in our public repo. +So far, we have only triggered tests and generated reports/badges. We were able to use free GitHub runner and licensing in our public repo. However, our final goal is to compile our app into a web app. For this we will need a license of MATLAB Compiler. This will be provided by a BATCH TOKEN. @@ -1348,12 +1348,9 @@ Once the `Deploy/ Release (main)` job is done, a new artifact is available at th ![image_107.png](WorkshopGuide_media/image_107.png) -You can now download the CTF file and upload it to your Web App Server using your github username and the password `BMS2026` +You can now download the CTF file and upload it to your Web App Server! - -[https://vdi\-wd1ah2\-348.dhcp.mathworks.com:9999/webapps/home/login.html](https://vdi-wd1ah2-348.dhcp.mathworks.com:9999/webapps/home/login.html) - - + # Workshop wrap\-up and additional information diff --git a/resources/project/Project.xml b/resources/project/Project.xml index dfe1ea3..11657a2 100644 --- a/resources/project/Project.xml +++ b/resources/project/Project.xml @@ -579,5 +579,10 @@ + + + + +