614 lines
30 KiB
HTML
614 lines
30 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="navy" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Release Checklist - JellyTau Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Requirements, traceability, and architecture for the JellyTau Jellyfin client.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="highlight.css">
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
</head>
|
|
<body class="sidebar-visible no-js">
|
|
<div id="body-container">
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "navy";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('navy')
|
|
html.classList.add(theme);
|
|
var body = document.querySelector('body');
|
|
body.classList.remove('no-js')
|
|
body.classList.add('js');
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
var body = document.querySelector('body');
|
|
var sidebar = null;
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
body.classList.remove('sidebar-visible');
|
|
body.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="index.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">Requirements & Traceability</li><li class="chapter-item expanded "><a href="requirements.html"><strong aria-hidden="true">1.</strong> Requirements Specification</a></li><li class="chapter-item expanded "><a href="traceability.html"><strong aria-hidden="true">2.</strong> Traceability Matrix</a></li><li class="chapter-item expanded "><a href="traceability-ci.html"><strong aria-hidden="true">3.</strong> Traceability CI</a></li><li class="chapter-item expanded "><a href="traces-quick-ref.html"><strong aria-hidden="true">4.</strong> Traces Quick Reference</a></li><li class="chapter-item expanded affix "><li class="part-title">Architecture</li><li class="chapter-item expanded "><a href="architecture/index.html"><strong aria-hidden="true">5.</strong> Overview</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="architecture/01-rust-backend.html"><strong aria-hidden="true">5.1.</strong> Rust Backend</a></li><li class="chapter-item "><a href="architecture/02-svelte-frontend.html"><strong aria-hidden="true">5.2.</strong> Svelte Frontend</a></li><li class="chapter-item "><a href="architecture/03-data-flow.html"><strong aria-hidden="true">5.3.</strong> Data Flow</a></li><li class="chapter-item "><a href="architecture/04-type-sync-and-threading.html"><strong aria-hidden="true">5.4.</strong> Type Sync & Threading</a></li><li class="chapter-item "><a href="architecture/05-platform-backends.html"><strong aria-hidden="true">5.5.</strong> Platform Backends</a></li><li class="chapter-item "><a href="architecture/06-downloads-and-offline.html"><strong aria-hidden="true">5.6.</strong> Downloads & Offline</a></li><li class="chapter-item "><a href="architecture/07-connectivity.html"><strong aria-hidden="true">5.7.</strong> Connectivity</a></li><li class="chapter-item "><a href="architecture/08-database-design.html"><strong aria-hidden="true">5.8.</strong> Database Design</a></li><li class="chapter-item "><a href="architecture/09-security.html"><strong aria-hidden="true">5.9.</strong> Security</a></li></ol></li><li class="chapter-item expanded "><li class="part-title">UX</li><li class="chapter-item expanded "><a href="ux-flows.html"><strong aria-hidden="true">6.</strong> UX Flows</a></li><li class="chapter-item expanded affix "><li class="part-title">Specs — Pending Work</li><li class="chapter-item expanded "><a href="specs/index.html"><strong aria-hidden="true">7.</strong> Specs Index</a></li><li class="chapter-item expanded "><a href="specs/SPEC-TEMPLATE.html"><strong aria-hidden="true">8.</strong> Spec Template</a></li><li class="chapter-item expanded "><a href="specs/SPEC-REVIEW-CHECKLIST.html"><strong aria-hidden="true">9.</strong> Spec Review Checklist</a></li><li class="chapter-item expanded "><a href="specs/playback-backend-unification.html"><strong aria-hidden="true">10.</strong> Playback Backend Unification</a></li><li class="chapter-item expanded "><a href="specs/linux-native-video-spike.html"><strong aria-hidden="true">11.</strong> Linux Native Video Spike</a></li><li class="chapter-item expanded "><a href="specs/backend-owned-stream-selection.html"><strong aria-hidden="true">12.</strong> Backend-Owned Stream Selection</a></li><li class="chapter-item expanded "><a href="specs/player-facade-enforcement.html"><strong aria-hidden="true">13.</strong> Player Facade Enforcement</a></li><li class="chapter-item expanded "><a href="specs/windows-native-audio-backend.html"><strong aria-hidden="true">14.</strong> Windows Native Audio Backend</a></li><li class="chapter-item expanded "><a href="specs/libmpv2-migration.html"><strong aria-hidden="true">15.</strong> libmpv2 Migration</a></li><li class="chapter-item expanded "><a href="specs/read-through-media-cache.html"><strong aria-hidden="true">16.</strong> Read-Through Media Cache</a></li><li class="chapter-item expanded "><a href="specs/scoped-search.html"><strong aria-hidden="true">17.</strong> Scoped Search</a></li><li class="chapter-item expanded "><a href="specs/scoped-search-boundary.html"><strong aria-hidden="true">18.</strong> Scoped Search Boundary</a></li><li class="chapter-item expanded "><a href="specs/scoped-search-boundary-implementation.html"><strong aria-hidden="true">19.</strong> Scoped Search Boundary — Implementation</a></li><li class="chapter-item expanded "><a href="specs/frontend-domain-model.html"><strong aria-hidden="true">20.</strong> Frontend Domain Model</a></li><li class="chapter-item expanded "><a href="specs/desktop-native-video.html"><strong aria-hidden="true">21.</strong> Desktop Native Video</a></li><li class="chapter-item expanded "><a href="specs/build-provenance.html"><strong aria-hidden="true">22.</strong> Build Provenance</a></li><li class="chapter-item expanded affix "><li class="part-title">Build & Release</li><li class="chapter-item expanded "><a href="build/build-release.html"><strong aria-hidden="true">23.</strong> Build & Release</a></li><li class="chapter-item expanded "><a href="release-checklist.html" class="active"><strong aria-hidden="true">24.</strong> Release Checklist</a></li><li class="chapter-item expanded "><a href="native-player-verification.html"><strong aria-hidden="true">25.</strong> Native Player Verification</a></li><li class="chapter-item expanded "><a href="build/build-desktop-packages.html"><strong aria-hidden="true">26.</strong> Desktop Packaging</a></li><li class="chapter-item expanded "><a href="build/build-windows.html"><strong aria-hidden="true">27.</strong> Windows Build</a></li><li class="chapter-item expanded "><a href="defect-windows.html"><strong aria-hidden="true">28.</strong> Defect Windows</a></li><li class="chapter-item expanded "><a href="build/docker.html"><strong aria-hidden="true">29.</strong> Docker</a></li><li class="chapter-item expanded "><a href="build/build-builder-image.html"><strong aria-hidden="true">30.</strong> Builder Image</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><a href="api-redirect.html">Rust API Reference (rustdoc)</a></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<!-- Track and set sidebar scroll position -->
|
|
<script>
|
|
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
|
sidebarScrollbox.addEventListener('click', function(e) {
|
|
if (e.target.tagName === 'A') {
|
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
|
}
|
|
}, { passive: true });
|
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
|
sessionStorage.removeItem('sidebar-scroll');
|
|
if (sidebarScrollTop) {
|
|
// preserve sidebar scroll position when navigating via links within sidebar
|
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
|
} else {
|
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
|
var activeSection = document.querySelector('#sidebar .active');
|
|
if (activeSection) {
|
|
activeSection.scrollIntoView({ block: 'center' });
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">JellyTau Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://gitea.tourolle.paris/dtourolle/jellytau" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://gitea.tourolle.paris/dtourolle/jellytau/_edit/master/docs/../docs/release-checklist.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="release-checklist"><a class="header" href="#release-checklist">Release Checklist</a></h1>
|
|
<p>Quick reference for creating a JellyTau release.</p>
|
|
<h2 id="pre-release-1-2-days-before"><a class="header" href="#pre-release-1-2-days-before">Pre-Release (1-2 days before)</a></h2>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Code is on <code>master</code>/<code>main</code> branch</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
All feature branches are merged and tested</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
No failing tests locally: <code>bun run test</code> and <code>bun run test:rust</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Requirement traceability check passes: <code>bun run traces:json</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Type checking passes: <code>bun run check</code></li>
|
|
</ul>
|
|
<h2 id="update-version-day-before"><a class="header" href="#update-version-day-before">Update Version (Day before)</a></h2>
|
|
<ul>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Decide on version number (semantic versioning)</p>
|
|
<ul>
|
|
<li>Example: <code>v1.2.0</code> (major.minor.patch)</li>
|
|
<li>Example: <code>v1.0.0-rc1</code> (release candidate)</li>
|
|
<li>Example: <code>v1.0.0-beta</code> (beta)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Update version in files:</p>
|
|
<pre><code class="language-bash"># Check these files for version numbers
|
|
cat package.json | grep version
|
|
cat src-tauri/tauri.conf.json | grep version
|
|
cat src-tauri/Cargo.toml | grep version
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Update <code>CHANGELOG.md</code>:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Add section for new version</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
List all features added</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
List all bugs fixed</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
List breaking changes (if any)</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Add upgrade instructions (if needed)</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Format: Markdown with clear sections</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Update <code>README.md</code>:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Update any version references</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Update feature list if applicable</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Update requirements if changed</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Commit changes:</p>
|
|
<pre><code class="language-bash">git add .
|
|
git commit -m "Bump version to v1.2.0"
|
|
git push origin master
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
<h2 id="final-check-before-release"><a class="header" href="#final-check-before-release">Final Check Before Release</a></h2>
|
|
<ul>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Run full test suite:</p>
|
|
<pre><code class="language-bash">bun run test # Frontend tests
|
|
bun run test:rust # Rust tests
|
|
bun run check # Type checking
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Build locally (optional but recommended):</p>
|
|
<pre><code class="language-bash"># Test Linux build
|
|
bun run tauri build
|
|
|
|
# Test Android build
|
|
bun run tauri android build
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
No uncommitted changes:</p>
|
|
<pre><code class="language-bash">git status # Should show clean working directory
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
<h2 id="release-tag--push"><a class="header" href="#release-tag--push">Release (Tag & Push)</a></h2>
|
|
<pre><code class="language-bash"># 1. Create annotated tag with release notes
|
|
git tag -a v1.2.0 -m "Release version 1.2.0
|
|
|
|
Features:
|
|
- New feature 1
|
|
- New feature 2
|
|
|
|
Fixes:
|
|
- Fixed bug 1
|
|
- Fixed bug 2
|
|
|
|
Improvements:
|
|
- Performance improvement 1
|
|
- UI improvement 1
|
|
|
|
Breaking Changes:
|
|
- None (or list if applicable)
|
|
|
|
Migration:
|
|
- No action required (or include steps if applicable)"
|
|
|
|
# 2. Push tag to trigger workflow
|
|
git push origin v1.2.0
|
|
|
|
# 3. Monitor in Gitea Actions
|
|
# Go to Actions tab and watch the workflow run
|
|
</code></pre>
|
|
<h2 id="during-release-while-workflow-runs"><a class="header" href="#during-release-while-workflow-runs">During Release (While Workflow Runs)</a></h2>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Watch workflow progress in Gitea Actions</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Monitor for test failures</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Monitor for build failures</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Check build logs if any step fails</li>
|
|
</ul>
|
|
<h2 id="after-release-workflow-complete"><a class="header" href="#after-release-workflow-complete">After Release (Workflow Complete)</a></h2>
|
|
<ul>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Download artifacts from release page:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>JellyTau_*.AppImage</code> (Linux)</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>JellyTau_*.deb</code> (Linux)</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>JellyTau-*.rpm</code> (Linux)</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>jellytau-release.apk</code> (Android)</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>jellytau-release.aab</code> (Android)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Basic testing of artifacts:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Linux AppImage runs</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Linux DEB installs and runs</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Android APK installs (via <code>adb</code> or sideload)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Verify release page:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Title is correct: "JellyTau vX.Y.Z"</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Release notes are formatted correctly</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
All artifacts are uploaded</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Release type is correct (prerelease vs release)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Verify integrity metadata (DR-216):</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>SHA256SUMS</code> is present, and <code>sha256sum -c SHA256SUMS</code> passes in the
|
|
directory you downloaded into</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
SBOM files are present (<code>*.cdx.json</code>, <code>frontend-dependencies.txt</code>)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Verify the update path (DR-217) — this is the step that catches a broken
|
|
updater <em>before</em> users hit it, because a bad manifest fails only on their
|
|
machine:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>latest.json</code> is live and names this version:
|
|
<code>curl -s https://gitea.tourolle.paris/dtourolle/jellytau/raw/branch/updater/latest.json | jq .version</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Both platform entries carry a non-empty <code>signature</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
The <code>.AppImage.tar.gz</code>, its <code>.sig</code>, and the NSIS <code>.sig</code> are among the
|
|
release assets — the manifest points at them</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Install the <strong>previous</strong> release, launch it, and use Settings → Updates:
|
|
it should offer this version, install it, and relaunch</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
On Android, Settings → Updates offers the releases page rather than an
|
|
install button (the updater plugin is not compiled for that target)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><input disabled="" type="checkbox"/>
|
|
Announce release:</p>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Post to relevant channels/communities</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Update website/docs</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Tag contributors if applicable</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2 id="rollback-if-issues-found"><a class="header" href="#rollback-if-issues-found">Rollback (If Issues Found)</a></h2>
|
|
<p>If critical issues are found after release:</p>
|
|
<pre><code class="language-bash"># Option 1: Delete tag locally and remotely
|
|
git tag -d v1.2.0
|
|
git push origin :refs/tags/v1.2.0
|
|
|
|
# Option 2: Mark as prerelease in release page
|
|
# Then plan immediate patch release (v1.2.1)
|
|
|
|
# Option 3: Create hotfix branch and release v1.2.1
|
|
git checkout -b hotfix/v1.2.1
|
|
# Fix issues
|
|
git commit -m "Fix critical issue"
|
|
git tag v1.2.1
|
|
git push origin hotfix/v1.2.1 v1.2.1
|
|
</code></pre>
|
|
<h2 id="version-examples"><a class="header" href="#version-examples">Version Examples</a></h2>
|
|
<h3 id="major-release"><a class="header" href="#major-release">Major Release</a></h3>
|
|
<pre><code>v2.0.0 - Major version bump
|
|
- Significant new features
|
|
- Breaking API changes
|
|
- Major UI redesign
|
|
</code></pre>
|
|
<h3 id="minor-release"><a class="header" href="#minor-release">Minor Release</a></h3>
|
|
<pre><code>v1.2.0 - Feature release
|
|
- New features
|
|
- Backward compatible
|
|
- Bug fixes
|
|
</code></pre>
|
|
<h3 id="patch-release"><a class="header" href="#patch-release">Patch Release</a></h3>
|
|
<pre><code>v1.1.1 - Bug fix/patch
|
|
- Bug fixes only
|
|
- No new features
|
|
- Backward compatible
|
|
</code></pre>
|
|
<h3 id="pre-releases"><a class="header" href="#pre-releases">Pre-releases</a></h3>
|
|
<pre><code>v1.2.0-alpha - Early development
|
|
v1.2.0-beta - Late development, feature complete
|
|
v1.2.0-rc1 - Release candidate, minimal fixes only
|
|
</code></pre>
|
|
<h2 id="file-locations"><a class="header" href="#file-locations">File Locations</a></h2>
|
|
<p>Key files for versioning:</p>
|
|
<ul>
|
|
<li><code>package.json</code> - Frontend version</li>
|
|
<li><code>src-tauri/tauri.conf.json</code> - Tauri config version</li>
|
|
<li><code>src-tauri/Cargo.toml</code> - Rust version</li>
|
|
<li><code>CHANGELOG.md</code> - Release history</li>
|
|
<li><code>README.md</code> - Project documentation</li>
|
|
</ul>
|
|
<h2 id="troubleshooting"><a class="header" href="#troubleshooting">Troubleshooting</a></h2>
|
|
<h3 id="tests-fail-before-release"><a class="header" href="#tests-fail-before-release">Tests Fail Before Release</a></h3>
|
|
<ol>
|
|
<li>Don't push tag yet</li>
|
|
<li>Fix failing tests locally</li>
|
|
<li>Push fixes to master</li>
|
|
<li>Re-run test suite</li>
|
|
<li>Then tag and push</li>
|
|
</ol>
|
|
<h3 id="build-fails-in-ci"><a class="header" href="#build-fails-in-ci">Build Fails in CI</a></h3>
|
|
<ol>
|
|
<li>Check detailed logs in Gitea Actions</li>
|
|
<li>Fix issue locally</li>
|
|
<li>Delete tag: <code>git tag -d v1.2.0 && git push origin :refs/tags/v1.2.0</code></li>
|
|
<li>Push fix to master</li>
|
|
<li>Create new tag with fix</li>
|
|
</ol>
|
|
<h3 id="release-already-exists"><a class="header" href="#release-already-exists">Release Already Exists</a></h3>
|
|
<ol>
|
|
<li>If workflow runs twice, artifacts may conflict</li>
|
|
<li>Check release page</li>
|
|
<li>If duplicates exist, delete and re-release</li>
|
|
</ol>
|
|
<h3 id="artifacts-missing"><a class="header" href="#artifacts-missing">Artifacts Missing</a></h3>
|
|
<ol>
|
|
<li>Check build logs for errors</li>
|
|
<li>Verify platform-specific dependencies</li>
|
|
<li>Delete tag and retry after fixes</li>
|
|
</ol>
|
|
<h2 id="performance-tips"><a class="header" href="#performance-tips">Performance Tips</a></h2>
|
|
<ul>
|
|
<li>Tests: ~5-10 minutes</li>
|
|
<li>Linux build: ~10-15 minutes</li>
|
|
<li>Android build: ~15-20 minutes</li>
|
|
<li>Total release time: ~30-45 minutes</li>
|
|
</ul>
|
|
<p>First build takes longer (cache warming). Subsequent releases are faster due to caching.</p>
|
|
<h2 id="template-release-notes"><a class="header" href="#template-release-notes">Template: Release Notes</a></h2>
|
|
<pre><code>## 🎉 JellyTau vX.Y.Z
|
|
|
|
### ✨ Features
|
|
- New feature 1
|
|
- New feature 2
|
|
|
|
### 🐛 Bug Fixes
|
|
- Fixed issue #123
|
|
- Fixed issue #456
|
|
|
|
### 🚀 Performance
|
|
- Improvement 1
|
|
- Improvement 2
|
|
|
|
### 📱 Downloads
|
|
- [Linux AppImage](#) - Run on any Linux
|
|
- [Linux DEB](#) - Install on Ubuntu/Debian
|
|
- [Android APK](#) - Install on Android devices
|
|
- [Android AAB](#) - For Google Play Store
|
|
|
|
### 📋 Requirements
|
|
**Linux:** 64-bit, GLIBC 2.29+
|
|
**Android:** 8.0+
|
|
|
|
### 🔗 Links
|
|
- [Changelog](https://gitea.tourolle.paris/dtourolle/jellytau/src/branch/master/CHANGELOG.md)
|
|
- [Issues](https://gitea.tourolle.paris/dtourolle/jellytau/issues)
|
|
|
|
---
|
|
Built with Tauri, SvelteKit, and Rust 🦀
|
|
</code></pre>
|
|
<h2 id="quick-commands"><a class="header" href="#quick-commands">Quick Commands</a></h2>
|
|
<pre><code class="language-bash"># View existing tags
|
|
git tag -l
|
|
|
|
# Create release locally (dry run)
|
|
git tag -a v1.2.0 -m "Release v1.2.0" --dry-run
|
|
|
|
# List commits since last tag
|
|
git log v1.1.0..HEAD --oneline
|
|
|
|
# Show tag details
|
|
git show v1.2.0
|
|
|
|
# Rename tag (if needed)
|
|
git tag v1.2.0_old v1.2.0
|
|
git tag -d v1.2.0
|
|
git push origin v1.2.0_old v1.2.0
|
|
|
|
# Delete tag locally and remotely
|
|
git tag -d v1.2.0
|
|
git push origin :refs/tags/v1.2.0
|
|
</code></pre>
|
|
<hr />
|
|
<p><strong>Tips:</strong></p>
|
|
<ul>
|
|
<li>✅ Always test locally before release</li>
|
|
<li>✅ Use semantic versioning consistently</li>
|
|
<li>✅ Document changes in CHANGELOG</li>
|
|
<li>✅ Wait for full workflow completion</li>
|
|
<li>✅ Test release artifacts before announcing</li>
|
|
</ul>
|
|
<p><strong>Remember:</strong> A good release is a tested release! 🚀</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="build/build-release.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="native-player-verification.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="build/build-release.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="native-player-verification.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|