<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>ci/build-docs.sh - fork/wezterm @ main</title>
<meta name="description" content="ci/build-docs.sh in fork/wezterm at main.">
<meta property="og:title" content="ci/build-docs.sh - fork/wezterm @ main">
<meta property="og:description" content="ci/build-docs.sh in fork/wezterm at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="9c883a71b8b60323047762d8b47ae44f101773c6">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="ade88725b02bcfa6b6df9e5cc5c03c06a892172a">ci/build-docs.sh: also support running under podman</span><span class="snapshot-sha sha" data-commit="ade88725b02bcfa6b6df9e5cc5c03c06a892172a">ade88725b</span><time datetime="2025-04-15T05:22:39-07:00" title="2025-04-15 05:22:39 -0700">2025-04-15</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/main/tree/ci/">ci</a> / <span class="cur">build-docs.sh</span></nav>
<span class="view-stats"><span>2.2 KiB</span><span>71 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/0104ad0d8fe3b8aa09850132cafd740ae1278ff1/ci/build-docs.sh">raw</a></span></header>
<pre class="code src language-bash"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>#!/bin/bash</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-pr>SERVE</a-pr>=no</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-k>if</a-k> [ <a-s>&quot;</a-s><a-o>$</a-o><a-pr>1</a-pr><a-s>&quot;</a-s> == <a-s>&quot;serve&quot;</a-s> ] ; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">  <a-pr>SERVE</a-pr>=yes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-k>fi</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-k>for</a-k> <a-pr>util</a-pr> <a-k>in</a-k> gelatyx ; <a-k>do</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">  <a-k>if</a-k> ! <a-f>hash</a-f> <a-o>$</a-o><a-pr>util</a-pr> <a-n>2</a-n><a-o>&gt;</a-o>/dev/null ; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">    <a-f>cargo</a-f> install <a-o>$</a-o><a-pr>util</a-pr> <a-co>--locked</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">  <a-k>fi</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-k>done</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-pr>tracked_markdown</a-pr>=<a-eb>$(</a-eb><a-f>mktemp</a-f><a-eb>)</a-eb></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-f>trap</a-f> <a-s>&quot;rm </a-s><a-eb>${</a-eb><a-pr>tracked_markdown</a-pr><a-eb>}</a-eb><a-s>&quot;</a-s> <a-s>&quot;EXIT&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-f>find</a-f> docs <a-co>-type</a-co> f <a-o>|</a-o> <a-f>egrep</a-f> <a-s>&#39;\.(markdown|md)$&#39;</a-s> <a-o>&gt;</a-o> <a-o>$</a-o><a-pr>tracked_markdown</a-pr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-f>gelatyx</a-f> <a-co>--language</a-co> lua <a-co>--file-list</a-co> <a-o>$</a-o><a-pr>tracked_markdown</a-pr> <a-co>--language-config</a-co> ci/stylua.toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-f>gelatyx</a-f> <a-co>--language</a-co> lua <a-co>--file-list</a-co> <a-o>$</a-o><a-pr>tracked_markdown</a-pr> <a-co>--language-config</a-co> ci/stylua.toml <a-co>--check</a-co> || <a-f>exit</a-f> 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-f>set</a-f> <a-co>-ex</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-c># Use the GH CLI to make an authenticated request if available,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-c># otherwise just do an ad-hoc curl.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-c># However, if we are called from within a GH actions workflow (BUILD_REASON</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-c># is set), only use `gh` if GH_TOKEN is also set, otherwise it will refuse</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-c># to run.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-k>function</a-k> <a-f>ghapi</a-f>() {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">  <a-k>if</a-k> <a-f>hash</a-f> gh <a-n>2</a-n><a-o>&gt;</a-o>/dev/null <a-o>&amp;&amp;</a-o> <a-f>test</a-f> \( <a-co>-n</a-co> <a-s>&quot;</a-s><a-o>$</a-o><a-pr>BUILD_REASON</a-pr><a-s>&quot;</a-s> <a-co>-a</a-co> <a-co>-n</a-co> <a-s>&quot;</a-s><a-o>$</a-o><a-pr>GH_TOKEN</a-pr><a-s>&quot;</a-s> \) <a-co>-o</a-co> <a-co>-z</a-co> <a-s>&quot;</a-s><a-o>$</a-o><a-pr>BUILD_REASON</a-pr><a-s>&quot;</a-s>; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">    <a-f>gh</a-f> api <a-o>$</a-o><a-pr>1</a-pr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">  <a-k>else</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">    <a-f>curl</a-f> https://api.github.com<a-o>$</a-o><a-pr>1</a-pr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">  <a-k>fi</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">[[ -f /tmp/wezterm.releases.json ]] || <a-f>ghapi</a-f> /repos/wezterm/wezterm/releases <a-o>&gt;</a-o> /tmp/wezterm.releases.json</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">[[ -f /tmp/wezterm.nightly.json ]] || <a-f>ghapi</a-f> /repos/wezterm/wezterm/releases/tags/nightly <a-o>&gt;</a-o> /tmp/wezterm.nightly.json</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-f>python3</a-f> ci/subst-release-info.py || <a-f>exit</a-f> 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-f>python3</a-f> ci/generate-docs.py || <a-f>exit</a-f> 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-c># Adjust path to pick up pip-installed binaries</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-pr>PATH</a-pr>=<a-s>&quot;</a-s><a-o>$</a-o><a-pr>HOME</a-pr><a-s>/.local/bin;</a-s><a-o>$</a-o><a-pr>PATH</a-pr><a-s>&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-k>if</a-k> <a-f>hash</a-f> black <a-n>2</a-n><a-o>&gt;</a-o>/dev/null ; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">  <a-f>black</a-f> ci/generate-docs.py ci/subst-release-info.py</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-k>fi</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-f>cp</a-f> <a-s>&quot;assets/icon/terminal.png&quot;</a-s> docs/favicon.png</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-f>cp</a-f> <a-s>&quot;assets/icon/wezterm-icon.svg&quot;</a-s> docs/favicon.svg</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-f>mkdir</a-f> <a-co>-p</a-co> docs/fonts</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-f>cp</a-f> assets/fonts/SymbolsNerdFontMono-Regular.ttf docs/fonts/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-f>docker_or_podman</a-f>() {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">  <a-k>if</a-k> <a-f>hash</a-f> podman <a-n>2</a-n><a-o>&gt;</a-o>/dev/null ; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">    <a-f>podman</a-f> <a-s>&quot;</a-s><a-o>$</a-o><a-s>@&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">  <a-k>elif</a-k> <a-f>hash</a-f> docker <a-n>2</a-n><a-o>&gt;</a-o>/dev/null ; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text">    <a-f>docker</a-f> <a-s>&quot;</a-s><a-o>$</a-o><a-s>@&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">  <a-k>else</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">    <a-f>echo</a-f> <a-s>&quot;Please install either podman or docker&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">    <a-f>exit</a-f> 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">  <a-k>fi</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-f>docker_or_podman</a-f> build <a-co>-t</a-co> wezterm/mkdocs-material <a-co>-f</a-co> ci/Dockerfile.docs .</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-k>if</a-k> [ <a-s>&quot;</a-s><a-o>$</a-o><a-pr>SERVE</a-pr><a-s>&quot;</a-s> == <a-s>&quot;yes&quot;</a-s> ] ; <a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">  <a-f>docker_or_podman</a-f> run <a-co>--rm</a-co> <a-co>-it</a-co> <a-co>-p8000:8000</a-co> <a-co>-v</a-co> <a-eb>${</a-eb><a-pr>PWD</a-pr><a-eb>}</a-eb>:/docs wezterm/mkdocs-material serve <a-co>-a</a-co> 0.0.0.0:8000</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">  <a-c>#docker_or_podman run --rm -it --network=host -v ${PWD}:/docs wezterm/mkdocs-material $@</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-k>else</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text">  <a-f>docker_or_podman</a-f> run <a-co>--rm</a-co> <a-co>-e</a-co> CARDS=true <a-co>-v</a-co> <a-eb>${</a-eb><a-pr>PWD</a-pr><a-eb>}</a-eb>:/docs wezterm/mkdocs-material build</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-k>fi</a-k></span></span></pre>
</main>
</body>
</html>
