Deployed 1c62d2b with MkDocs version: 1.5.3

index.html

@@ -326,9 +326,9 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#folder_stucture" class="md-nav__link">
+  <a href="#folder_structure" class="md-nav__link">
     <span class="md-ellipsis">
-      Folder Stucture
+      Folder Structure
     </span>
   </a>
 
@@ -393,9 +393,9 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#folder_stucture" class="md-nav__link">
+  <a href="#folder_structure" class="md-nav__link">
     <span class="md-ellipsis">
-      Folder Stucture
+      Folder Structure
     </span>
   </a>
 
@@ -440,7 +440,7 @@ <h2 id="about">About<a class="headerlink" href="#about" title="Permanent link">&
 This project contains a <code>simple_loop.py</code> python file that prints a progress bar of a for loop.
 The aim of this project to serve a sample project for implementing GitHub's 
 workflow using workflow files, and custom actions and multiple jobs.</p>
-<h3 id="folder_stucture">Folder Stucture<a class="headerlink" href="#folder_stucture" title="Permanent link">&para;</a></h3>
+<h3 id="folder_structure">Folder Structure<a class="headerlink" href="#folder_structure" title="Permanent link">&para;</a></h3>
 <pre><code>continuous_integration
 │
 ├── README.md

search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Continuous Integration","text":""},{"location":"#about","title":"About","text":"<p>A sample project of adding continuous integration  to GitHub and utilising the GitHub actions, workflows and job settings. This project contains a <code>simple_loop.py</code> python file that prints a progress bar of a for loop. The aim of this project to serve a sample project for implementing GitHub's  workflow using workflow files, and custom actions and multiple jobs.</p>"},{"location":"#folder_stucture","title":"Folder Stucture","text":"<pre><code>continuous_integration\n\u2502\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 .github # gitHub workflow directory\n\u2502     \u251c\u2500\u2500 actions # Custom actions directory\n\u2502     \u2502   \u2514\u2500\u2500 install-run-code # This project's Custom Action to be referred to by name in workflows\n\u2502     \u2502       \u2514\u2500\u2500 action.yml # Action instructions file [Must be named action]\n\u2502     \u2514\u2500\u2500 workflows # This project's Workflows \n\u2502         \u2514\u2500\u2500 ci_workflow.yml # Workflow instructions file\n\u251c\u2500\u2500 .gitignore\n\u251c\u2500\u2500 pyproject.toml\n\u2514\u2500\u2500 simple_loop.py\n</code></pre>"},{"location":"#getting_started","title":"Getting Started","text":"<p>There is no need to run the project locally, but in case it is needed here is the quick start instructions used.  Note: Those are the same instructions in <code>.github/workflows/ci_workflows.yml</code> and <code>.github/actions/install-run-code/actions.yml</code></p> <p>Project is also setup for a Docker Multi-arch build for <code>arm64</code> and <code>amd64</code>. Read more about it in this article.</p> <p>Create a virtualenv </p> <pre><code> virtualenv venv -p python3\n</code></pre> <p>Activate your venv</p> <pre><code>source venv/bin/activate\n</code></pre> <p>Install poetry and pyfiglet using pip</p> <pre><code>pip install poetry pyfiglet\n</code></pre> <p>Run poetry install to install all needed python packages</p> <pre><code>poetry install\n</code></pre> <p>Run pyfiglet because you can </p> <pre><code>pyfiglet Continuous Integration\n</code></pre> <p>Finally, run code</p> <pre><code>python simple_loop.py\n</code></pre> <p>You should have something like that: </p> <pre><code>This is a progress bar of the simple loop script\n100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 1000000/1000000 [00:00&lt;00:00, 4474649.76it/s]\n</code></pre>"}]}
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Continuous Integration","text":""},{"location":"#about","title":"About","text":"<p>A sample project of adding continuous integration  to GitHub and utilising the GitHub actions, workflows and job settings. This project contains a <code>simple_loop.py</code> python file that prints a progress bar of a for loop. The aim of this project to serve a sample project for implementing GitHub's  workflow using workflow files, and custom actions and multiple jobs.</p>"},{"location":"#folder_structure","title":"Folder Structure","text":"<pre><code>continuous_integration\n\u2502\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 .github # gitHub workflow directory\n\u2502     \u251c\u2500\u2500 actions # Custom actions directory\n\u2502     \u2502   \u2514\u2500\u2500 install-run-code # This project's Custom Action to be referred to by name in workflows\n\u2502     \u2502       \u2514\u2500\u2500 action.yml # Action instructions file [Must be named action]\n\u2502     \u2514\u2500\u2500 workflows # This project's Workflows \n\u2502         \u2514\u2500\u2500 ci_workflow.yml # Workflow instructions file\n\u251c\u2500\u2500 .gitignore\n\u251c\u2500\u2500 pyproject.toml\n\u2514\u2500\u2500 simple_loop.py\n</code></pre>"},{"location":"#getting_started","title":"Getting Started","text":"<p>There is no need to run the project locally, but in case it is needed here is the quick start instructions used.  Note: Those are the same instructions in <code>.github/workflows/ci_workflows.yml</code> and <code>.github/actions/install-run-code/actions.yml</code></p> <p>Project is also setup for a Docker Multi-arch build for <code>arm64</code> and <code>amd64</code>. Read more about it in this article.</p> <p>Create a virtualenv </p> <pre><code> virtualenv venv -p python3\n</code></pre> <p>Activate your venv</p> <pre><code>source venv/bin/activate\n</code></pre> <p>Install poetry and pyfiglet using pip</p> <pre><code>pip install poetry pyfiglet\n</code></pre> <p>Run poetry install to install all needed python packages</p> <pre><code>poetry install\n</code></pre> <p>Run pyfiglet because you can </p> <pre><code>pyfiglet Continuous Integration\n</code></pre> <p>Finally, run code</p> <pre><code>python simple_loop.py\n</code></pre> <p>You should have something like that: </p> <pre><code>This is a progress bar of the simple loop script\n100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 1000000/1000000 [00:00&lt;00:00, 4474649.76it/s]\n</code></pre>"}]}