<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>assets/release-checklist.md - fork/numbat @ master</title>
<meta name="description" content="assets/release-checklist.md in fork/numbat at master.">
<meta property="og:title" content="assets/release-checklist.md - fork/numbat @ master">
<meta property="og:description" content="assets/release-checklist.md in fork/numbat at master.">
<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="master" data-tip="b070b880c8a713bac881084034ea6f0d857868ed">
<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/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">David Peter</span><span class="commit-message" data-commit="aaf3943618957bd0670895ef959c0d464a7d73c7">Add release checklist</span><span class="snapshot-sha sha" data-commit="aaf3943618957bd0670895ef959c0d464a7d73c7">aaf3943</span><time datetime="2024-03-09T22:33:10+01:00" title="2024-03-09 22:33:10 +0100">2024-03-09</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <a href="/fork/numbat/ref/master/tree/assets/">assets</a> / <span class="cur">release-checklist.md</span></nav>
<span class="view-stats"><span>2.3 KiB</span><span>53 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/b8d7d5463bcf027867b9a6f8db7f8d78471e7e89/assets/release-checklist.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Release checklist</h1>
<p>This file can be used as-is, or copied into the GitHub PR description which includes
necessary changes for the upcoming release.</p>
<h2>Version bump</h2>
<ul>
<li><input disabled="" type="checkbox"/>
Get the latest version by running <code>git tag | sort -V | tail -n1</code>
or <code>grep ^version numbat/Cargo.toml</code>.</li>
<li><input disabled="" type="checkbox"/>
Check if there are any changes in <code>numbat-exchange-rates</code> since the
last release by running <code>git diff vX.Y.Z.. numbat-exchange-rates</code>. If that
is the case, bump the version in <code>numbat-exchange-rates/Cargo.toml</code>.</li>
<li><input disabled="" type="checkbox"/>
Update versions and dependencies in the following files:
<code>    numbat/Cargo.toml numbat-cli/Cargo.toml    </code>
<code>Cargo.toml</code>. Run <code>cargo build</code> to update <code>Cargo.lock</code>.
Make sure to <code>git add</code> the <code>Cargo.lock</code> changes as well.</li>
<li><input disabled="" type="checkbox"/>
Update the <code>numbat</code> version in <code>book/src/cli-installation.md</code>.</li>
<li><input disabled="" type="checkbox"/>
Run <code>deploy.sh</code> (or at least <code>build.sh</code>) in <code>numbat-wasm/</code> to
update the <code>Cargo.lock</code> file.</li>
</ul>
<h2>Pre-release checks and updates</h2>
<ul>
<li><input disabled="" type="checkbox"/>
Install the latest version (<code>cargo install -f --path numbat-cli</code>) and make
sure that it is available on the <code>PATH</code> (<code>numbat --version</code> should show the
new version).</li>
<li><input disabled="" type="checkbox"/>
Push all changes and wait for CI to succeed (before continuing with the
next section).</li>
<li><input disabled="" type="checkbox"/>
Run <code>cargo publish --dry-run -p numbat</code> to make sure that it will succeed later
(after creating the GitHub release).</li>
</ul>
<h2>Release</h2>
<ul>
<li>
<p><input disabled="" type="checkbox"/>
Create a tag and push it: <code>git tag vX.Y.Z; git push origin tag vX.Y.Z</code>.
This will trigger the deployment via GitHub Actions.
REMINDER: If your <code>origin</code> is a fork, don't forget to push to e.g. <code>upstream</code>
instead.</p>
</li>
<li>
<p><input disabled="" type="checkbox"/>
Go to https://github.com/sharkdp/numbat/releases/new to create the new
release. Select the new tag and also use it as the release title. Autogenerate
the release notes, edit, and then publish the release.</p>
</li>
<li>
<p><input disabled="" type="checkbox"/>
Check if the binary deployment works (archives and Debian packages should
appear when the CI run <em>for the Git tag</em> has finished).</p>
</li>
<li>
<p><input disabled="" type="checkbox"/>
Publish to crates.io by running <code>cargo publish</code> in a <em>clean</em> repository.
One way to do this is to clone a fresh copy.
``` bash
# optional, if there were any changes:
cargo publish -p numbat-exchange-rates</p>
<pre><code>cargo publish -p numbat
cargo publish -p numbat-cli
```
</code></pre>
</li>
<li>
<p><input disabled="" type="checkbox"/>
Deploy the documentation by running <code>bash book/deploy.sh</code>.</p>
</li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Release checklist</a-tt></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">This file can be used as-is, or copied into the GitHub PR description which includes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">necessary changes for the upcoming release.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></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-p>##</a-p> <a-tt>Version bump</a-tt></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-p>- </a-p>[ ] Get the latest version by running `git tag | sort -V | tail -n1`</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-p>  </a-p>    or `grep ^version numbat/Cargo.toml`.</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-p>- </a-p>[ ] Check if there are any changes in `numbat-exchange-rates` since the</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-p>  </a-p>    last release by running `git diff vX.Y.Z.. numbat-exchange-rates`. If that</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-p>  </a-p>    is the case, bump the version in `numbat-exchange-rates/Cargo.toml`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>- </a-p>[ ] Update versions and dependencies in the following files:</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-p>  </a-p><a-tl>    ```</a-tl></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-p>      </a-p><a-tl>numbat/Cargo.toml numbat-cli/Cargo.toml</a-tl></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-p>      </a-p><a-tl>```</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>      </a-p><a-tl>`Cargo.toml`. Run `cargo build` to update `Cargo.lock`.</a-tl></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-p>      </a-p><a-tl>Make sure to `git add` the `Cargo.lock` changes as well.</a-tl></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-p>- </a-p>[ ] Update the `numbat` version in `book/src/cli-installation.md`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>- </a-p>[ ] Run `deploy.sh` (or at least `build.sh`) in `numbat-wasm/` to</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-p>  </a-p>    update the `Cargo.lock` file.</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-p>## </a-p><a-tt>Pre-release checks and updates</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></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-p>- [ ] Install the latest version (`cargo install -f --path numbat-cli`) and make</a-p></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-p>      sure that it is available on the `PATH` (`numbat --version` should show the</a-p></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-p>      new version).</a-p></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-p>- [ ] Push all changes and wait for CI to succeed (before continuing with the</a-p></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-p>      next section).</a-p></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-p>- [ ] Run `cargo publish --dry-run -p numbat` to make sure that it will succeed later</a-p></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-p>      (after creating the GitHub release).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></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-p>## </a-p><a-tt>Release</a-tt></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"><a-p>- [ ] Create a tag and push it: `git tag vX.Y.Z; git push origin tag vX.Y.Z`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>      This will trigger the deployment via GitHub Actions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>      REMINDER: If your `origin` is a fork, don&#39;t forget to push to e.g. `upstream`</a-p></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-p>      instead.</a-p></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-p>- [ ] Go to https://github.com/sharkdp/numbat/releases/new to create the new</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>      release. Select the new tag and also use it as the release title. Autogenerate</a-p></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-p>      the release notes, edit, and then publish the release.</a-p></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-p>- [ ] Check if the binary deployment works (archives and Debian packages should</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>      appear when the CI run *for the Git tag* has finished).</a-p></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-p>- [ ] Publish to crates.io by running `cargo publish` in a *clean* repository.</a-p></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-p>      One way to do this is to clone a fresh copy.</a-p></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-p>  </a-p><a-tl>    ``` bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>      </a-p><a-tl># optional, if there were any changes:</a-tl></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-p>      </a-p><a-tl>cargo publish -p numbat-exchange-rates</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></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-p>      cargo publish -p numbat</a-p></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-p>      cargo publish -p numbat-cli</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>      ```</a-p></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-p>- </a-p>[ ] Deploy the documentation by running `bash book/deploy.sh`.</span></span></pre></div></div>
</main>
</body>
</html>
