<!-- CANARY: REQ=REQ-DOCS-001; FEATURE="Docs"; ASPECT=Documentation; STATUS=TESTED; OWNER=docs; UPDATED=2026-01-15 --> <p>Understanding what changes between versions is critical for maintaining stable, secure, and performant graph database deployments. Geode maintains a comprehensive changelog documenting every feature addition, bug fix, performance improvement, and breaking change across all releases. This transparency enables informed upgrade decisions and smooth migration paths.</p> <p>As an enterprise-ready graph database aligned with the ISO/IEC 39075:2024 100% GQL compliance, Geode follows semantic versioning (MAJOR.MINOR.PATCH) and maintains backward compatibility within major versions. This guide explains how to track changes, understand release cycles, and plan upgrades effectively.</p> <h3 id="understanding-the-changelog" class="position-relative d-flex align-items-center group"> <span>Understanding the Changelog</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="understanding-the-changelog" aria-haspopup="dialog" aria-label="Share link: Understanding the Changelog"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> <i class="fa-solid fa-xmark"></i> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> <i class="fa-duotone fa-clipboard" aria-hidden="true"></i> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> <i class="fa-brands fa-twitter me-2"></i>Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> <i class="fa-brands fa-linkedin me-2"></i>LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> <i class="fa-brands fa-facebook me-2"></i>Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script><p>Geode&rsquo;s changelog follows the &ldquo;Keep a Changelog&rdquo; format with entries organized by version and categorized by change type:</p> <p><strong>Change Categories</strong>:</p> <ul> <li><strong>Added</strong>: New features and capabilities</li> <li><strong>Changed</strong>: Modifications to existing functionality</li> <li><strong>Deprecated</strong>: Features marked for removal in future versions</li> <li><strong>Removed</strong>: Features removed in this version</li> <li><strong>Fixed</strong>: Bug fixes and corrections</li> <li><strong>Security</strong>: Security improvements and vulnerability patches</li> <li><strong>Performance</strong>: Performance optimizations and improvements</li> </ul> <h3 id="current-version-geode_tag-current-stable-release" class="position-relative d-flex align-items-center group"> <span>Current Version: &lt;strong&gt;v0.2.18&lt;/strong&gt; (Current Stable Release)</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="current-version-geode_tag-current-stable-release" aria-haspopup="dialog" aria-label="Share link: Current Version: GEODE_ (Current Stable Release)"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>Status</strong>: Current stable release (<strong>March 2026</strong>) <strong>Released</strong>: <strong>March 30, 2026</strong></p> <h4 id="highlights" class="position-relative d-flex align-items-center group"> <span>Highlights</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="highlights" aria-haspopup="dialog" aria-label="Share link: Highlights"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h4><ul> <li>100% GQL compliance (see conformance profile)</li> <li><code>v0.2.18</code> release cut validated with 619/619 unit tests</li> <li>Current mainline GAP analysis tracking 3847 passed, 70 failed, 35 skipped</li> <li>Enterprise-ready with full ACID transactions</li> <li>QUIC + TLS 1.3 protocol support</li> <li>Multi-language client libraries (Go, Python, Rust, Zig)</li> </ul> <h4 id="added-in-v0215" class="position-relative d-flex align-items-center group"> <span>Added in v0.2.15</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="added-in-v0215" aria-haspopup="dialog" aria-label="Share link: Added in v0.2.15"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h4><p><strong>Core Features</strong>:</p> <ul> <li>Common table expressions (CTEs) in the stable release line</li> <li>DOT output fixes for graph visualization workflows</li> <li>DSN graph binding and graph-scoped session behavior</li> <li>Per-graph storage and graph-storage integration across the March release train</li> <li>Current auth CLI flows for login, init, reseal, and verify</li> </ul> <p><strong>Performance Enhancements</strong>:</p> <ul> <li>QUIC stream multiplexing for better concurrency</li> <li>Poll-loop reductions and accepted-connection wait improvements</li> <li>Storage engine fixes for graph mappings, free-space bitmap rebuilds, and adapter label dictionaries</li> <li>Large-result stability carried forward from the <code>v0.1.x</code> line</li> </ul> <p><strong>Client Libraries</strong>:</p> <ul> <li>Go client rolling stable module</li> <li>Python async client v0.3.19</li> <li>Rust client v0.1.1-alpha.8</li> <li>Zig client v0.1.0</li> </ul> <p><strong>Tooling</strong>:</p> <ul> <li>Interactive GQL shell with syntax highlighting</li> <li>EXPLAIN and PROFILE query analysis</li> <li>Backup and restore utilities</li> <li>Data import/export tools (JSON, CSV, GraphML)</li> <li>Prometheus metrics integration</li> </ul> <h4 id="changed-in-v0215" class="position-relative d-flex align-items-center group"> <span>Changed in v0.2.15</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="changed-in-v0215" aria-haspopup="dialog" aria-label="Share link: Changed in v0.2.15"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h4><ul> <li><code>v0.2.x</code> became the active stable line for the docs and release process</li> <li>Release notes now distinguish the tagged stable release from unreleased <code>main</code> fixes</li> <li>Auth, storage, and upgrade guidance now reflect the March 2026 release train</li> <li>TDE wiring and post-tag storage fixes are tracked separately as unreleased <code>main</code> work</li> </ul> <h4 id="fixed-in-v0215" class="position-relative d-flex align-items-center group"> <span>Fixed in v0.2.15</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="fixed-in-v0215" aria-haspopup="dialog" aria-label="Share link: Fixed in v0.2.15"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h4><ul> <li>UUIDv7 generation on 32-bit ARM</li> <li>CTE execution stability issues found during the March release train</li> <li>DOT export correctness for current graph visualization examples</li> <li>Storage edge-slot translation and UUID truncation issues addressed on <code>main</code> after the tag</li> </ul> <h3 id="release-cycles-and-versioning" class="position-relative d-flex align-items-center group"> <span>Release Cycles and Versioning</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="release-cycles-and-versioning" aria-haspopup="dialog" aria-label="Share link: Release Cycles and Versioning"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>Semantic Versioning</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"><span class="line"><span class="cl">MAJOR.MINOR.PATCH </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">MAJOR: Breaking changes, incompatible API changes </span></span><span class="line"><span class="cl">MINOR: New features, backward-compatible additions </span></span><span class="line"><span class="cl">PATCH: Bug fixes, backward-compatible corrections </span></span></code></pre></div><p><strong>Release Schedule</strong>:</p> <ul> <li><strong>Major Releases</strong>: Annual (breaking changes, major features)</li> <li><strong>Minor Releases</strong>: Quarterly (new features, enhancements)</li> <li><strong>Patch Releases</strong>: As needed (bug fixes, security patches)</li> <li><strong>Security Updates</strong>: Immediate (critical vulnerabilities)</li> </ul> <h3 id="breaking-changes-policy" class="position-relative d-flex align-items-center group"> <span>Breaking Changes Policy</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="breaking-changes-policy" aria-haspopup="dialog" aria-label="Share link: Breaking Changes Policy"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p>Geode maintains backward compatibility within major versions. Breaking changes are:</p> <ol> <li><strong>Announced in Advance</strong>: Deprecated features marked at least one minor version before removal</li> <li><strong>Documented Thoroughly</strong>: Migration guides provided for all breaking changes</li> <li><strong>Limited to Majors</strong>: Breaking changes only in major version releases</li> <li><strong>Minimized</strong>: Breaking changes avoided unless absolutely necessary</li> </ol> <p><strong>Example Breaking Change Process</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"><span class="line"><span class="cl">v1.5.0: Feature marked as deprecated </span></span><span class="line"><span class="cl">v1.6.0: Deprecation warning in logs </span></span><span class="line"><span class="cl">v1.7.0: Migration guide published </span></span><span class="line"><span class="cl">v2.0.0: Feature removed </span></span></code></pre></div> <h3 id="viewing-the-changelog" class="position-relative d-flex align-items-center group"> <span>Viewing the Changelog</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="viewing-the-changelog" aria-haspopup="dialog" aria-label="Share link: Viewing the Changelog"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>GitHub Repository</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="c1"># View full changelog</span> </span></span><span class="line"><span class="cl">https://github.com/codeprosorg/geode/blob/main/CHANGELOG.md </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># View changes between versions</span> </span></span><span class="line"><span class="cl">git log v0.2.14..v0.2.15 --oneline </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># View release notes</span> </span></span><span class="line"><span class="cl">https://github.com/codeprosorg/geode/releases </span></span></code></pre></div><p><strong>Built-in Command</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="c1"># Display changelog for current version</span> </span></span><span class="line"><span class="cl">geode changelog </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># Display changelog for specific version</span> </span></span><span class="line"><span class="cl">geode changelog --version v0.2.15 </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># Display all changes since version</span> </span></span><span class="line"><span class="cl">geode changelog --since v0.1.0 </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># Display only security fixes</span> </span></span><span class="line"><span class="cl">geode changelog --category security </span></span></code></pre></div><p><strong>Web Documentation</strong>:</p> <p>Visit /docs/reference/changelog/ for interactive changelog with:</p> <ul> <li>Filterable change categories</li> <li>Version comparison</li> <li>Migration guide links</li> <li>Affected API documentation</li> </ul> <h3 id="migration-guides" class="position-relative d-flex align-items-center group"> <span>Migration Guides</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="migration-guides" aria-haspopup="dialog" aria-label="Share link: Migration Guides"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p>Each major and significant minor release includes a migration guide:</p> <p><strong>Upgrade from v0.1.x to v0.1.x</strong>:</p> <ol> <li> <p><strong>Backup Existing Database</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">geode backup create --output pre-upgrade-backup.tar.gz </span></span></code></pre></div></li> <li> <p><strong>Review Breaking Changes</strong>:</p> <ul> <li>Protocol changed to QUIC-only (no TCP fallback)</li> <li>Default port changed from 8443 to 3141</li> <li>Wire format is now Protobuf wire protocol exclusively</li> </ul> </li> <li> <p><strong>Update Client Libraries</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="c1"># Go</span> </span></span><span class="line"><span class="cl">go get -u geodedb.com/[email protected] </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># Python</span> </span></span><span class="line"><span class="cl">pip install --upgrade geode-client<span class="o">==</span>1.0.0 </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># Rust</span> </span></span><span class="line"><span class="cl">cargo update geode-client </span></span></code></pre></div></li> <li> <p><strong>Update Configuration</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="c"># config.yaml</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">server</span><span class="p">:</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">listen</span><span class="p">:</span><span class="w"> </span><span class="s2">&#34;0.0.0.0:3141&#34;</span><span class="w"> </span><span class="c"># Changed from 8443</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">protocol</span><span class="p">:</span><span class="w"> </span><span class="s2">&#34;quic&#34;</span><span class="w"> </span><span class="c"># TCP removed</span><span class="w"> </span></span></span></code></pre></div></li> <li> <p><strong>Test in Staging</strong>:</p> <ul> <li>Deploy to staging environment</li> <li>Run integration test suite</li> <li>Validate performance benchmarks</li> </ul> </li> <li> <p><strong>Deploy to Production</strong>:</p> <ul> <li>Schedule maintenance window</li> <li>Perform rolling upgrade for clusters</li> <li>Monitor metrics and logs</li> </ul> </li> </ol> <h3 id="version-compatibility-matrix" class="position-relative d-flex align-items-center group"> <span>Version Compatibility Matrix</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="version-compatibility-matrix" aria-haspopup="dialog" aria-label="Share link: Version Compatibility Matrix"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>Server Compatibility</strong>:</p> <table> <thead> <tr> <th>Server Version</th> <th>Go Client</th> <th>Python Client</th> <th>Rust Client</th> <th>Zig Client</th> </tr> </thead> <tbody> <tr> <td>v0.1.x</td> <td>v1.0.x</td> <td>v1.0.x</td> <td>v1.0.x</td> <td>v1.0.x</td> </tr> <tr> <td>v0.1.x</td> <td>v0.9.x</td> <td>v0.9.x</td> <td>v0.9.x</td> <td>v0.9.x</td> </tr> <tr> <td>v0.1.x</td> <td>v0.8.x</td> <td>v0.8.x</td> <td>v0.8.x</td> <td>v0.8.x</td> </tr> </tbody> </table> <p><strong>Protocol Compatibility</strong>:</p> <table> <thead> <tr> <th>Version</th> <th>Protocol</th> <th>Wire Format</th> <th>TLS Version</th> </tr> </thead> <tbody> <tr> <td>v0.1.x</td> <td>QUIC</td> <td>JSON Line</td> <td>TLS 1.3</td> </tr> <tr> <td>v0.1.x</td> <td>QUIC/TCP</td> <td>Binary/JSON</td> <td>TLS 1.2+</td> </tr> <tr> <td>v0.1.x</td> <td>TCP</td> <td>Binary</td> <td>TLS 1.2+</td> </tr> </tbody> </table> <h3 id="security-advisories" class="position-relative d-flex align-items-center group"> <span>Security Advisories</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-advisories" aria-haspopup="dialog" aria-label="Share link: Security Advisories"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p>Security vulnerabilities are tracked separately and disclosed responsibly:</p> <p><strong>Reporting Security Issues</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"><span class="line"><span class="cl">Email: [email protected] </span></span><span class="line"><span class="cl">PGP Key: https://geodedb.com/security/pgp-key.asc </span></span><span class="line"><span class="cl">Response Time: 48 hours </span></span></code></pre></div><p><strong>Security Update Process</strong>:</p> <ol> <li>Issue reported privately to security team</li> <li>Vulnerability assessed and patch developed</li> <li>Security advisory published (CVE assigned if applicable)</li> <li>Patch released with security tag (e.g., v0.2.15-security)</li> <li>Users notified via security mailing list</li> </ol> <p><strong>Current Security Status</strong>: No known vulnerabilities in the tagged stable release (as of <code>v0.2.18</code>)</p> <h3 id="deprecation-notices" class="position-relative d-flex align-items-center group"> <span>Deprecation Notices</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="deprecation-notices" aria-haspopup="dialog" aria-label="Share link: Deprecation Notices"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>Currently Deprecated</strong> (removal planned for v1.0.0):</p> <p>None currently. The stable <code>v0.2.18</code> feature set is the supported baseline in the docs.</p> <p><strong>Previously Deprecated and Removed</strong>:</p> <ul> <li>v0.1.2: TCP protocol support (removed before the current <code>v0.2.x</code> line)</li> <li>v0.1.1: Legacy JSON line protocol (removed in v0.1.2; Protobuf required)</li> <li>v0.1.0: Legacy authentication API (removed in v0.1.1)</li> </ul> <h3 id="changelog-best-practices" class="position-relative d-flex align-items-center group"> <span>Changelog Best Practices</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="changelog-best-practices" aria-haspopup="dialog" aria-label="Share link: Changelog Best Practices"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>For Users</strong>:</p> <ol> <li><strong>Subscribe to Notifications</strong>: Watch the GitHub repository for release announcements</li> <li><strong>Review Before Upgrading</strong>: Always read the changelog before upgrading</li> <li><strong>Test Upgrades</strong>: Use staging environments to validate changes</li> <li><strong>Plan Migrations</strong>: Allow time for migration when breaking changes are introduced</li> <li><strong>Track Dependencies</strong>: Ensure client libraries match server versions</li> </ol> <p><strong>For Contributors</strong>:</p> <ol> <li><strong>Update Changelog</strong>: Add entries for all significant changes</li> <li><strong>Categorize Correctly</strong>: Use appropriate change categories</li> <li><strong>Provide Context</strong>: Explain why changes were made, not just what changed</li> <li><strong>Link Issues</strong>: Reference GitHub issues and pull requests</li> <li><strong>Document Migrations</strong>: Include migration steps for breaking changes</li> </ol> <h3 id="automated-changelog-tools" class="position-relative d-flex align-items-center group"> <span>Automated Changelog Tools</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="automated-changelog-tools" aria-haspopup="dialog" aria-label="Share link: Automated Changelog Tools"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><p><strong>Generate Changelog from Git</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="c1"># Generate changelog since last tag</span> </span></span><span class="line"><span class="cl">git log <span class="k">$(</span>git describe --tags --abbrev<span class="o">=</span>0<span class="k">)</span>..HEAD --oneline --no-merges </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># Generate formatted changelog</span> </span></span><span class="line"><span class="cl">conventional-changelog -p angular -i CHANGELOG.md -s </span></span></code></pre></div><p><strong>CI/CD Integration</strong>:</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="c"># .github/workflows/release.yml</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Generate Changelog</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="p">|</span><span class="sd"> </span></span></span><span class="line"><span class="cl"><span class="sd"> npx conventional-changelog-cli -p angular -i CHANGELOG.md -s </span></span></span><span class="line"><span class="cl"><span class="sd"> git add CHANGELOG.md </span></span></span><span class="line"><span class="cl"><span class="sd"> git commit -m &#34;docs: Update changelog for release&#34;</span><span class="w"> </span></span></span></code></pre></div> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> <span>Related Topics</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><ul> <li>Release Notes and Versioning</li> <li>Version Management</li> <li>Migration Guides</li> <li>Security Advisories</li> <li>Upgrade Procedures</li> <li>Compatibility Matrix</li> <li>Breaking Changes Policy</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> <span>Further Reading</span> <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> <i class="fa-sharp-duotone fa-solid fa-share-nodes" aria-hidden="true" style="font-size: 0.8em;"></i> <span class="visually-hidden">Share link</span> </button> </h3><ul> <li>Semantic Versioning Specification</li> <li>Keep a Changelog Format</li> <li>Release Management Best Practices</li> <li>Database Upgrade Strategies</li> <li>Security Disclosure Policy</li> <li>Dependency Management</li> <li>Version Compatibility Testing</li> </ul>

Related Articles