👥 adding contributors to readme (#7)

.ci/scripts/updateContributors.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# Assign the filename
+README_TPL="./.ci/templates/README.hbs"
+README_TPL_TEMP="./.ci/templates/README.temp.hbs"
+
+# Create temporary files
+CONTRIBUTORS_FILE="./.ci/templates/contributors.temp.md"
+cp $README_TPL $README_TPL_TEMP
+touch $CONTRIBUTORS_FILE
+
+# Run contributor update to contributor temp file
+npx contributor-table --dirname "$SCRIPT_DIR" --readme $CONTRIBUTORS_FILE
+
+# Add our emoji back to header
+sed -i "" s/"## Contributors"/"## 👥 Contributors"/ $CONTRIBUTORS_FILE
+
+# Store our files to merge
+README_OUTPUT=$(<$README_TPL)
+CONTRIBUTOR_OUTPUT=$(<$CONTRIBUTORS_FILE)
+
+# Merge files replacing pointer in TPL file
+echo "${README_OUTPUT//"{{CONTRIBUTORS}}"/$CONTRIBUTOR_OUTPUT}" >$README_TPL_TEMP
+
+# Clean up contributor temp file
+rm $CONTRIBUTORS_FILE
+
+# Sound of script completed
+echo -e "\033[0;32m Contributors Updated \033[0m"

.ci/templates/README.hbs

@@ -34,6 +34,8 @@ Azure yaml pipeline files are provided in [`.ci/workflows`](./.ci/workflows).
 
 - [`azure-pipelines-docs.yml`](./.ci/workflows/azure-pipelines-docs.yml) -- Generates documentation, commits,and pushes back to current PR/branch
 
+{{CONTRIBUTORS}}
+
 {{>main}}
 
-Happy Coding!
+Happy Coding! 🥳

README.md

@@ -34,6 +34,13 @@ Azure yaml pipeline files are provided in [`.ci/workflows`](./.ci/workflows).
 
 - [`azure-pipelines-docs.yml`](./.ci/workflows/azure-pipelines-docs.yml) -- Generates documentation, commits,and pushes back to current PR/branch
 
+## 👥 Contributors
+
+| Name               | GitHub                                  | Twitter                                   |
+| ------------------ | --------------------------------------- | ----------------------------------------- |
+| **Ryan Valizan**   | [devnetkc](https://github.com/devnetkc) | [@devnetkc](https://twitter.com/devnetkc) |
+| **GitHub Actions** | [actions](https://github.com/actions)   | [@](https://twitter.com/)                 |
+
 ## Modules
 
 <dl>
@@ -141,4 +148,4 @@ Example set custom body field value for record
 | options.value | <code>String</code> | Value to set record field to |
 
 
-Happy Coding!
+Happy Coding! 🥳

docs/customJestStubs.js.html

@@ -116,7 +116,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.html

@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/module-CustomJestStubs.html

@@ -893,7 +893,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/module-aModule.html

@@ -645,7 +645,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/module-bModule.html

@@ -558,7 +558,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/stubs_SuiteScripts_Modules_aModule.js.html

@@ -114,7 +114,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/stubs_SuiteScripts_Modules_bModule.js.html

@@ -95,7 +95,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aM
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 20:35:46 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Nov 27 2022 15:17:18 GMT-0600 (Central Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>