Merge pull request #130 from mediumroast/V0.8.0--dev

Fix doc eratta and clean up action
mediumroast · Dec 29, 2024 · 02a4bcb · 02a4bcb
2 parents f44f2ff + 344e018
commit 02a4bcb
Show file tree

Hide file tree

Showing 30 changed files with 46 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -74,6 +74,11 @@ If you detect a problem or want to suggest an improvement open an [issue](https:
 If you need support or would like to have Mediumroast run the Caffeine Machine Intelligence service on your repository please contact the Mediumroast team via [Discord](https://discord.gg/ebM4Cf8meK) or email us at [hello@mediumroast.io], (mailto:hello@mediumroast.io).
 
 ### Release notes
+#### Version 0.8.06.02
+- Resolved documentation errata for Demo.md
+- Updated text for basic reporting workflow and action to show both companies and study reports are running.
+- Removed debugging logging statements from basic reporting action.
+
 #### Version 0.8.06.01
 - The latest version of the SDK and CLI package now includes an initial implementation of Studies with the Foundation study. 
 - The SDK and CLI may run on for Windows OS, but it has not been tested. If you choose to install and run into problems please open an issue and we will work with you to resolve the matter.

diff --git a/cli/Demo.md b/cli/Demo.md
@@ -11,18 +11,18 @@ With this configuration file by updating the `org` value to `MegaRoast` you can
 [DEFAULT]
 company_dns=https://company-dns.mediumroast.io
 company_logos=https://icon-server.mediumroast.io/allicons.json?url=
-echarts=https://echart-server.mediumroast.io:11000
+echarts=https://chart-server.mediumroast.io:11000
 nominatim=https://nominatim.openstreetmap.org/search?addressdetails=1&q=
 working_directory=working
 report_output_dir=Documents
-theme=coffee
+theme=latte
 
 [GitHub]
 clientId=Iv1.f5c0a4eb1f0606f8
 appId=650476
-authType=deviceFlow
-org=<ORGANIZATION>
 token=<TOKEN>
+authType=deviceFlow
+org=MegaRoast
 ```
 
 ### Limitations

diff --git a/cli/actions/actions/basic-reporting/action.yml b/cli/actions/actions/basic-reporting/action.yml
@@ -1,5 +1,5 @@
 name: 'Basic Reporting'
-description: 'Generates basic reports for companies plus wrapping README.md files in the repository'
+description: 'Generates basic reports for companies and studies plus wrapping README.md files in the repository'
 inputs:
   github-token:
     description: 'GitHub token'

diff --git a/cli/actions/actions/basic-reporting/study.js b/cli/actions/actions/basic-reporting/study.js
@@ -167,12 +167,10 @@ async function createStudyReport (studies, companies, reports) {
 
         // ---- Check if the study is caffinated ----
         const [caffinated, caffinatedMessage] = _checkCaffinated(study)
-        console.log('CAFFINATED STATUS>>>',caffinated)
         if (caffinated === true) {
             // ---- BEGIN Top Insights ----
             // Get the top insights
             const topInsights = await _getTopInsights(study)
-            console.log('TOP INSIGHTS>>>',topInsights)
             studyFile += topInsights
             // ---- END Top Insights ----
         } else {

diff --git a/cli/actions/workflows/basic-reporting.yml b/cli/actions/workflows/basic-reporting.yml
@@ -18,7 +18,7 @@ jobs:
           - name: Install dependencies
             run: npm install
             working-directory: ./.github/actions/basic-reporting
-          - name: Generate basic reports for companies
+          - name: Generate basic reports for companies and studies
             uses: ./.github/actions/basic-reporting
             with:
               github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/GitHubFunctions.GitHubFunctions.html b/docs/GitHubFunctions.GitHubFunctions.html
@@ -347,7 +347,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/authorize.js.html b/docs/authorize.js.html
@@ -372,7 +372,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/classes.list.html b/docs/classes.list.html
@@ -207,7 +207,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/gitHubServer.js.html b/docs/gitHubServer.js.html
@@ -707,7 +707,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/github.js.html b/docs/github.js.html
@@ -1282,7 +1282,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/index.html b/docs/index.html
@@ -162,6 +162,12 @@ <h2>Issues</h2>
 <h2>Support</h2>
 <p>If you need support or would like to have Mediumroast run the Caffeine Machine Intelligence service on your repository please contact the Mediumroast team via <a href="https://discord.gg/ebM4Cf8meK">Discord</a> or email us at [hello@mediumroast.io], (mailto:hello@mediumroast.io).</p>
 <h3>Release notes</h3>
+<h4>Version 0.8.06.02</h4>
+<ul>
+<li>Resolved documentation errata for Demo.md</li>
+<li>Updated text for basic reporting workflow and action to show both companies and study reports are running.</li>
+<li>Removed debugging logging statements from basic reporting action.</li>
+</ul>
 <h4>Version 0.8.06.01</h4>
 <ul>
 <li>The latest version of the SDK and CLI package now includes an initial implementation of Studies with the Foundation study.</li>
@@ -218,7 +224,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-GitHubAuth-GitHubAuth.html b/docs/module-GitHubAuth-GitHubAuth.html
@@ -347,7 +347,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-GitHubAuth.html b/docs/module-GitHubAuth.html
@@ -529,7 +529,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-GitHubFunctions.html b/docs/module-GitHubFunctions.html
@@ -1173,7 +1173,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects-Actions.html b/docs/module-baseObjects-Actions.html
@@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects-Companies.html b/docs/module-baseObjects-Companies.html
@@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects-Interactions.html b/docs/module-baseObjects-Interactions.html
@@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects-Storage.html b/docs/module-baseObjects-Storage.html
@@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects-Studies.html b/docs/module-baseObjects-Studies.html
@@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects-Users.html b/docs/module-baseObjects-Users.html
@@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-baseObjects.html b/docs/module-baseObjects.html
@@ -1659,7 +1659,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/modules.list.html b/docs/modules.list.html
@@ -207,7 +207,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/quicksearch.html b/docs/quicksearch.html
diff --git a/docs/tutorial-Company.html b/docs/tutorial-Company.html
@@ -227,7 +227,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorial-Demo.html b/docs/tutorial-Demo.html
@@ -96,18 +96,18 @@ <h3>Example config.ini file</h3>
 <pre class="prettyprint source lang-ini"><code>[DEFAULT]
 company_dns=https://company-dns.mediumroast.io
 company_logos=https://icon-server.mediumroast.io/allicons.json?url=
-echarts=https://echart-server.mediumroast.io:11000
+echarts=https://chart-server.mediumroast.io:11000
 nominatim=https://nominatim.openstreetmap.org/search?addressdetails=1&q=
 working_directory=working
 report_output_dir=Documents
-theme=coffee
+theme=latte
 
 [GitHub]
 clientId=Iv1.f5c0a4eb1f0606f8
 appId=650476
-authType=deviceFlow
-org=&lt;ORGANIZATION>
 token=&lt;TOKEN>
+authType=deviceFlow
+org=MegaRoast
 </code></pre>
 <h3>Limitations</h3>
 <p>The following limitations are in place for the demo repository:</p>
@@ -157,7 +157,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorial-Interaction.html b/docs/tutorial-Interaction.html
@@ -228,7 +228,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorial-README.html b/docs/tutorial-README.html
@@ -192,7 +192,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorial-Study.html b/docs/tutorial-Study.html
@@ -218,7 +218,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorials.list.html b/docs/tutorials.list.html
@@ -207,7 +207,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
 
-		on Sat Dec 28th 2024
+		on Sun Dec 29th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mediumroast_js",
-  "version": "0.8.06.01",
+  "version": "0.8.06.02",
   "description": "A Command Line Interface (CLI) and Javascript SDK to interact with Mediumroast for GitHub.",
   "main": "cli/mrcli.js",
   "scripts": {