Rebuild iko docs

Author: bcb

iko/deploying/index.html

@@ -610,10 +610,7 @@ <h3 id="2-build-the-image">2. Build the image</h3>
 <h3 id="3-run-the-deploy-on-the-remote-environment">3. Run the deploy on the remote environment</h3>
 <p>On the target server or inside your CI/CD pipeline, run:</p>
 <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
-<span class="w"> </span>-e<span class="w"> </span><span class="nv">PG_USER</span><span class="o">=</span>youruser<span class="w"> </span><span class="se">\</span>
-<span class="w"> </span>-e<span class="w"> </span><span class="nv">PG_PASS</span><span class="o">=</span>yourpass<span class="w"> </span><span class="se">\</span>
-<span class="w"> </span>-e<span class="w"> </span><span class="nv">PG_HOST</span><span class="o">=</span>postgres<span class="w"> </span><span class="se">\</span>
-<span class="w"> </span>-e<span class="w"> </span><span class="nv">PG_DB</span><span class="o">=</span>app<span class="w"> </span><span class="se">\</span>
+<span class="w"> </span>-e<span class="w"> </span><span class="nv">PG_URI</span><span class="o">=</span>pg://user:pass@postgres/app<span class="w"> </span><span class="se">\</span>
 <span class="w"> </span>ghcr.io/your-org/iko-with-migrations:latest<span class="w"> </span>deploy<span class="w"> </span>--verify
 </code></pre></div>
 

iko/install.sh

@@ -10,10 +10,18 @@ mkdir -p "$INSTALL_DIR"
 cat > "$WRAPPER" <<'EOF'
 #!/bin/sh
 
-docker run --rm -it \
-  -v "${PWD}/migrations:/repo:rw" \
-  -v "${PWD}/scripts:/scripts:ro" \
-  ghcr.io/explodinglabs/iko:0.1.0 "$@"
+if [ -f .env ]; then
+  docker run --rm -it \
+    --env-file .env \
+    -v "${PWD}/migrations:/repo:rw" \
+    -v "${PWD}/scripts:/scripts:ro" \
+    ghcr.io/explodinglabs/iko:0.1.0 "$@"
+else
+  docker run --rm -it \
+    -v "${PWD}/migrations:/repo:rw" \
+    -v "${PWD}/scripts:/scripts:ro" \
+    ghcr.io/explodinglabs/iko:0.1.0 "$@"
+fi
 EOF
 
 chmod +x "$WRAPPER"

iko/installation/index.html

@@ -297,6 +297,19 @@
 
 
 
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          
+  
+  
+  <span class="md-ellipsis">
+    Installation
+    
+  </span>
+  
+
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      
       <a href="./" class="md-nav__link md-nav__link--active">
 
 
@@ -309,6 +322,34 @@
 
       </a>
 
+        
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+  
+  
+  
+    
+  
+  
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#1-install-the-development-cli-with" class="md-nav__link">
+    <span class="md-ellipsis">
+      1. Install the development CLI with:
+    </span>
+  </a>
+  
+</li>
+      
+    </ul>
+  
+</nav>
+      
     </li>
 
 
@@ -421,6 +462,23 @@
 
 
 
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#1-install-the-development-cli-with" class="md-nav__link">
+    <span class="md-ellipsis">
+      1. Install the development CLI with:
+    </span>
+  </a>
+  
+</li>
+      
+    </ul>
+  
 </nav>
                   </div>
                 </div>
@@ -443,10 +501,11 @@ <h1 id="installation">🚀 Installation</h1>
 <p>⚠️ <strong>Iko runs inside a container,</strong> so you'll need <a href="https://docs.docker.com/get-docker/">Docker
 installed</a>.</p>
 </blockquote>
-<p>Install with:</p>
+<h2 id="1-install-the-development-cli-with">1. Install the development CLI with:</h2>
 <div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://explodinglabs.com/iko/install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
 </code></pre></div>
-<p>Verify it's working:</p>
+<p>This installs a lightweight <code>iko</code> script to <code>~/.local/bin</code> that wraps <code>docker run</code>, and (if present) loads environment variables from a <code>.env</code> file.</p>
+<p>You can verify it’s working with:</p>
 <div class="highlight"><pre><span></span><code>iko<span class="w"> </span>version
 </code></pre></div>
 

iko/search/search_index.json

@@ -360,27 +360,36 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#1-initialise-a-project" class="md-nav__link">
+  <a href="#1-create-a-env-file" class="md-nav__link">
     <span class="md-ellipsis">
-      1. Initialise a project
+      1. Create a .env file
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#2-create-a-migration" class="md-nav__link">
+  <a href="#2-initialise-a-project" class="md-nav__link">
     <span class="md-ellipsis">
-      2. Create a migration
+      2. Initialise a project
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#3-deploy-it" class="md-nav__link">
+  <a href="#3-create-a-migration" class="md-nav__link">
     <span class="md-ellipsis">
-      3. Deploy it
+      3. Create a migration
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#4-deploy-it" class="md-nav__link">
+    <span class="md-ellipsis">
+      4. Deploy it
     </span>
   </a>
 
@@ -487,27 +496,36 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#1-initialise-a-project" class="md-nav__link">
+  <a href="#1-create-a-env-file" class="md-nav__link">
     <span class="md-ellipsis">
-      1. Initialise a project
+      1. Create a .env file
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#2-create-a-migration" class="md-nav__link">
+  <a href="#2-initialise-a-project" class="md-nav__link">
     <span class="md-ellipsis">
-      2. Create a migration
+      2. Initialise a project
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#3-deploy-it" class="md-nav__link">
+  <a href="#3-create-a-migration" class="md-nav__link">
     <span class="md-ellipsis">
-      3. Deploy it
+      3. Create a migration
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#4-deploy-it" class="md-nav__link">
+    <span class="md-ellipsis">
+      4. Deploy it
     </span>
   </a>
 
@@ -533,11 +551,16 @@
 
 
 <h1 id="usage">🛠️ Usage</h1>
-<h2 id="1-initialise-a-project">1. Initialise a project</h2>
-<div class="highlight"><pre><span></span><code>iko<span class="w"> </span>init<span class="w"> </span>--target<span class="w"> </span>db:pg://user:pass@postgres/dbname<span class="w"> </span>myapp
+<h2 id="1-create-a-env-file">1. Create a <code>.env</code> file</h2>
+<div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span><span class="s1">&#39;PG_URI=pg://user:pass@postgres/app&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>.env
+</code></pre></div>
+<h2 id="2-initialise-a-project">2. Initialise a project</h2>
+<div class="highlight"><pre><span></span><code>iko<span class="w"> </span>init<span class="w"> </span>--target<span class="w"> </span><span class="s1">&#39;$PG_URI&#39;</span><span class="w"> </span>myapp
 </code></pre></div>
-<p>This creates a new project with a <code>sqitch.plan</code>, ready for migrations.</p>
-<h2 id="2-create-a-migration">2. Create a migration</h2>
+<p>This creates a new Sqitch project in a <code>migrations</code> directory. The target is
+set to an environment variable, so it stays portable across dev, CI, and
+production environments.</p>
+<h2 id="3-create-a-migration">3. Create a migration</h2>
 <div class="highlight"><pre><span></span><code>iko<span class="w"> </span>create_schema<span class="w"> </span>api
 </code></pre></div>
 <div class="highlight"><pre><span></span><code>Created deploy/create_schema_api.sql
@@ -552,8 +575,8 @@ <h2 id="2-create-a-migration">2. Create a migration</h2>
 <li>The change was added to sqitch.plan.</li>
 <li>The deploy script was output for your review.</li>
 </ul>
-<h2 id="3-deploy-it">3. Deploy it</h2>
-<p>Make sure your database is running, then:</p>
+<h2 id="4-deploy-it">4. Deploy it</h2>
+<p>Ensure your Postgres server is running, then:</p>
 <div class="highlight"><pre><span></span><code>iko<span class="w"> </span>deploy
 </code></pre></div>