deploy: 6c37c22

JoseRZapata · Mar 25, 2024 · eb32598 · eb32598
1 parent 99e3356
commit eb32598
Show file tree

Hide file tree

Showing 9 changed files with 152 additions and 76 deletions.
diff --git a/404.html b/404.html
@@ -246,7 +246,7 @@
 
 
   <span class="md-ellipsis">
-    Introduction
+    📖 Introduction
   </span>
 
 
@@ -266,7 +266,7 @@
 
 
   <span class="md-ellipsis">
-    Setup Tokens
+    🔑 Setup Tokens
   </span>
 
 
@@ -286,7 +286,7 @@
 
 
   <span class="md-ellipsis">
-    Pre-commit configuration
+    ⚙️ Pre-commit configuration
   </span>
 
 
@@ -318,7 +318,7 @@
 
 
   <span class="md-ellipsis">
-    Github Actions
+    🚀 Github Actions
   </span>
 
 
@@ -328,7 +328,7 @@
         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
-            Github Actions
+            🚀 Github Actions
           </label>
           <ul class="md-nav__list" data-md-scrollfix>
 
@@ -371,7 +371,7 @@
 
 
   <span class="md-ellipsis">
-    VSCode configuration
+    💻 VSCode configuration
   </span>
 
 
@@ -391,7 +391,7 @@
 
 
   <span class="md-ellipsis">
-    My Local Dev setup
+    🏠 Local Dev setup
   </span>
 
 

diff --git a/github_actions/gh_action_pre-commit-autoupdate/index.html b/github_actions/gh_action_pre-commit-autoupdate/index.html
@@ -255,7 +255,7 @@
 
 
   <span class="md-ellipsis">
-    Introduction
+    📖 Introduction
   </span>
 
 
@@ -275,7 +275,7 @@
 
 
   <span class="md-ellipsis">
-    Setup Tokens
+    🔑 Setup Tokens
   </span>
 
 
@@ -295,7 +295,7 @@
 
 
   <span class="md-ellipsis">
-    Pre-commit configuration
+    ⚙️ Pre-commit configuration
   </span>
 
 
@@ -327,7 +327,7 @@
 
 
   <span class="md-ellipsis">
-    Github Actions
+    🚀 Github Actions
   </span>
 
 
@@ -337,7 +337,7 @@
         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
           <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
-            Github Actions
+            🚀 Github Actions
           </label>
           <ul class="md-nav__list" data-md-scrollfix>
 
@@ -438,7 +438,7 @@
 
 
   <span class="md-ellipsis">
-    VSCode configuration
+    💻 VSCode configuration
   </span>
 
 
@@ -458,7 +458,7 @@
 
 
   <span class="md-ellipsis">
-    My Local Dev setup
+    🏠 Local Dev setup
   </span>
 
 

diff --git a/index.html b/index.html
@@ -106,7 +106,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              Introduction
+              📖 Introduction
 
           </span>
         </div>
@@ -262,7 +262,7 @@
 
 
   <span class="md-ellipsis">
-    Introduction
+    📖 Introduction
   </span>
 
 
@@ -273,7 +273,7 @@
 
 
   <span class="md-ellipsis">
-    Introduction
+    📖 Introduction
   </span>
 
 
@@ -465,6 +465,39 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="👷 CI/CD">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#automatic-dependency-updates" class="md-nav__link">
+    <span class="md-ellipsis">
+      Automatic Dependency updates
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#dependency-review-in-pr" class="md-nav__link">
+    <span class="md-ellipsis">
+      Dependency Review in PR
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#pre-commit-automatic-updates" class="md-nav__link">
+    <span class="md-ellipsis">
+      Pre-commit automatic updates
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
       </ul>
@@ -571,7 +604,7 @@
 
 
   <span class="md-ellipsis">
-    Setup Tokens
+    🔑 Setup Tokens
   </span>
 
 
@@ -591,7 +624,7 @@
 
 
   <span class="md-ellipsis">
-    Pre-commit configuration
+    ⚙️ Pre-commit configuration
   </span>
 
 
@@ -623,7 +656,7 @@
 
 
   <span class="md-ellipsis">
-    Github Actions
+    🚀 Github Actions
   </span>
 
 
@@ -633,7 +666,7 @@
         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
-            Github Actions
+            🚀 Github Actions
           </label>
           <ul class="md-nav__list" data-md-scrollfix>
 
@@ -676,7 +709,7 @@
 
 
   <span class="md-ellipsis">
-    VSCode configuration
+    💻 VSCode configuration
   </span>
 
 
@@ -696,7 +729,7 @@
 
 
   <span class="md-ellipsis">
-    My Local Dev setup
+    🏠 Local Dev setup
   </span>
 
 
@@ -902,6 +935,39 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="👷 CI/CD">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#automatic-dependency-updates" class="md-nav__link">
+    <span class="md-ellipsis">
+      Automatic Dependency updates
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#dependency-review-in-pr" class="md-nav__link">
+    <span class="md-ellipsis">
+      Dependency Review in PR
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#pre-commit-automatic-updates" class="md-nav__link">
+    <span class="md-ellipsis">
+      Pre-commit automatic updates
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
       </ul>
@@ -1009,10 +1075,12 @@
 
 <h1 id="data-science-project-template">Data science project template</h1>
 <p><a href="https://python-poetry.org/"><img alt="Poetry" src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" /></a>
-<a href="https://github.com/charliermarsh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json" /></a>
+<a href="https://github.com/charliermarsh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" /></a>
 <a href="https://github.com/pre-commit/pre-commit"><img alt="pre-commit" src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&amp;logoColor=white" /></a>
+<a href="https://github.com/PyCQA/bandit"><img alt="security: bandit" src="https://img.shields.io/badge/security-bandit-yellow.svg" /></a>
+<a href="https://mypy-lang.org/"><img alt="Checked with mypy" src="https://www.mypy-lang.org/static/mypy_badge.svg" /></a>
 <a href="https://github.com/JoseRZapata/data-science-project-template/actions/workflows/pages/pages-build-deployment"><img alt="pages-build-deployment" src="https://github.com/JoseRZapata/data-science-project-template/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages" /></a>
-<a href="https://github.com/JoseRZapata/data-science-project-template/actions/workflows/test.yml"><img alt="Test" src="https://github.com/JoseRZapata/data-science-project-template/actions/workflows/test.yml/badge.svg?branch=main" /></a>
+<a href="https://github.com/JoseRZapata/data-science-project-template/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/JoseRZapata/data-science-project-template/actions/workflows/ci.yml/badge.svg" /></a>
 <a href="https://codecov.io/gh/JoseRZapata/data-science-project-template"><img alt="codecov" src="https://codecov.io/gh/JoseRZapata/data-science-project-template/graph/badge.svg?token=7LCPX574UF" /></a></p>
 <hr />
 <p>A modern template for data science projects with all the necessary tools for experiment, development, testing, and deployment. From notebooks to production.</p>
@@ -1042,7 +1110,12 @@ <h1 id="data-science-project-template">Data science project template</h1>
 <li><a href="#-code-formatting">🎨 Code formatting</a></li>
 </ul>
 </li>
-<li><a href="#-cicd">👷 CI/CD</a></li>
+<li><a href="#-cicd">👷 CI/CD</a><ul>
+<li><a href="#automatic-dependency-updates">Automatic Dependency updates</a></li>
+<li><a href="#dependency-review-in-pr">Dependency Review in PR</a></li>
+<li><a href="#pre-commit-automatic-updates">Pre-commit automatic updates</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li><a href="#-security">🔒 Security</a><ul>
@@ -1194,20 +1267,23 @@ <h5 id="code-formatting">🎨 Code formatting</h5>
 <li><a href="https://github.com/pre-commit/pre-commit-hooks#check-yaml"><code>check-yaml</code></a></li>
 </ul>
 <h4 id="cicd">👷 CI/CD</h4>
+<h5 id="automatic-dependency-updates">Automatic Dependency updates</h5>
 <ul>
-<li><strong>Dependency updates</strong>
-  with <a href="https://github.com/dependabot/dependabot-core">Dependabot</a></li>
 <li>
-<p>Automated <a href="https://github.com/dependabot/dependabot-core">Dependabot</a> PR merging with the <a href="https://github.com/ahmadnassri/action-dependabot-auto-merge">Dependabot Auto Merge GitHub Action</a></p>
-<ul>
-<li>Replacement for <a href="https://github.com/pypa/pip-audit">pip-audit</a> , <em>In your local environment,
-   If you want to check for vulnerabilities in your dependencies you can install this tool</em>.</li>
-</ul>
+<p>Dependency updates with <a href="https://github.com/dependabot/dependabot-core">Dependabot</a>, Automated <a href="https://github.com/dependabot/dependabot-core">Dependabot</a> PR merging with the <a href="https://github.com/ahmadnassri/action-dependabot-auto-merge">Dependabot Auto Merge GitHub Action</a></p>
 </li>
 <li>
-<p><strong>Pre-commit automatic updates</strong> with <a href="https://github.com/features/actions">GitHub Actions</a> workflow <code>.github/workflows/pre-commit_autoupdate.yml</code></p>
+<p>This is a replacement for <a href="https://github.com/pypa/pip-audit">pip-audit</a> , <em>In your local environment, If you want to check for vulnerabilities in your dependencies you can use [pip-audit]</em>.</p>
 </li>
 </ul>
+<h5 id="dependency-review-in-pr">Dependency Review in PR</h5>
+<ul>
+<li>Dependency Review  with <a href="https://github.com/actions/dependency-review-action">dependency-review-action</a>, This action scans your pull requests for dependency changes, and will raise an error if any vulnerabilities or invalid licenses are being introduced.</li>
+</ul>
+<h5 id="pre-commit-automatic-updates">Pre-commit automatic updates</h5>
+<ul>
+<li>Automatic updates with <a href="https://github.com/features/actions">GitHub Actions</a> workflow <code>.github/workflows/pre-commit_autoupdate.yml</code></li>
+</ul>
 <h2 id="security">🔒 Security</h2>
 <h3 id="static-application-security-testing-sast">🔏 Static Application Security Testing (SAST)</h3>
 <ul>