Deployed 45418ac with MkDocs version: 1.6.0

fgcz · Aug 13, 2024 · b3d988a · b3d988a
1 parent 0df6c75
commit b3d988a
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 1 deletion.
diff --git a/contribute/index.html b/contribute/index.html
@@ -310,6 +310,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#release" class="md-nav__link">
+    <span class="md-ellipsis">
+      Release
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -400,6 +409,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#release" class="md-nav__link">
+    <span class="md-ellipsis">
+      Release
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -435,6 +453,16 @@ <h2 id="documentation">Documentation</h2>
 # To publish after changes
 mkdocs gh-deploy
 </code></pre>
+<h2 id="release">Release</h2>
+<p>To create a release, increase the version in <code>pyproject.toml</code>, prepare <code>changelog.md</code>,
+commit everything and run <code>release.py</code>. This script will</p>
+<ul>
+<li>Create a tag and push it to GitHub</li>
+<li>Merge the changes to the <code>stable</code> branch and push it to GitHub</li>
+<li>Build the documentation and push it to GitHub Pages</li>
+</ul>
+<p>The only manual step that remains is creating a release on GitHub.
+To do so, you can paste the changelog section of the release and create a new release on GitHub using the tag that was created.</p>
 
 
 

diff --git a/index.html b/index.html
@@ -241,6 +241,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#updating" class="md-nav__link">
+    <span class="md-ellipsis">
+      Updating
+    </span>
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -353,6 +362,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#updating" class="md-nav__link">
+    <span class="md-ellipsis">
+      Updating
+    </span>
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -398,6 +416,10 @@ <h2 id="installation">Installation</h2>
     &quot;bfabric @ git+https://github.com/fgcz/bfabricPy.git@stable&quot;
 ]
 </code></pre>
+<h2 id="updating">Updating</h2>
+<p>If you installed with <code>pipx</code>, you can update the package to the most recent release with the following command:</p>
+<pre><code class="language-bash">pipx upgrade bfabric
+</code></pre>
 <h2 id="configuration">Configuration</h2>
 <p>Create a file as follows: (note: the password is not your login password, but the web service password available on your profile page)</p>
 <pre><code># ~/.bfabricpy.yml