300 lines
16 KiB
HTML
300 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Release Guide - Filament</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<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">
|
|
|
|
<!-- 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 -->
|
|
|
|
<!-- MathJax -->
|
|
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "light" : "light";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="body-container">
|
|
<!-- 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; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
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';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div style="display:flex;align-items:center;justify-content:center">
|
|
<img class="flogo" src="../images/filament_logo_small.png"></img>
|
|
</div>
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<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>
|
|
<!-- Filament: disable themes because the markdeep part does not look good for dark themes -->
|
|
<!--
|
|
<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">Filament</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="https://github.com/google/filament" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></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="filament-release-guide"><a class="header" href="#filament-release-guide">Filament Release Guide</a></h1>
|
|
<p>This guide makes use of some "environment variables":</p>
|
|
<ul>
|
|
<li>$RELEASE = the new version of Filament we are releasing today. (e.g., 1.9.3)</li>
|
|
<li>$NEXT_RELEASE = the version we plan to release next week (e.g., 1.9.4)</li>
|
|
</ul>
|
|
<p>Before starting, ensure that each of these branches is up-to-date with origin:</p>
|
|
<ul>
|
|
<li>release</li>
|
|
<li>rc/$RELEASE</li>
|
|
<li>main</li>
|
|
</ul>
|
|
<h2 id="0-check-versions"><a class="header" href="#0-check-versions">0. Check versions.</a></h2>
|
|
<p>Make sure the rc/$RELEASE branch has the correct Filament version. It should have the version
|
|
corresponding to its name, $RELEASE.</p>
|
|
<p>Make sure <code>MATERIAL_VERSION</code> has been bumped to a new version if this is a MAJOR or MINOR release
|
|
(first two version numbers).</p>
|
|
<h2 id="1-bump-filament-versions-on-main-to-release"><a class="header" href="#1-bump-filament-versions-on-main-to-release">1. Bump Filament versions on main to $RELEASE.</a></h2>
|
|
<p>Checkout main and run the following command to bump Filament's version to $RELEASE:</p>
|
|
<pre><code>build/common/bump-version.sh $RELEASE
|
|
</code></pre>
|
|
<p>Commit changes to main with the title:</p>
|
|
<pre><code>Release Filament $RELEASE
|
|
</code></pre>
|
|
<p>Do not push to origin yet.</p>
|
|
<h2 id="2-update-release_notesmd-on-main"><a class="header" href="#2-update-release_notesmd-on-main">2. Update RELEASE_NOTES.md on main.</a></h2>
|
|
<p>Create a new header in RELEASE_NOTES.md for $NEXT_RELEASE. Copy the release notes in
|
|
NEW_RELEASE_NOTES.md to RELEASE_NOTES.md under the new header. Clear NEW_RELEASE_NOTES.md.</p>
|
|
<p>Amend these changes to the "Release Filament $RELEASE" commit.</p>
|
|
<pre><code>git add -u
|
|
git commit --amend --no-edit
|
|
</code></pre>
|
|
<h2 id="3-run-release-script"><a class="header" href="#3-run-release-script">3. Run release script.</a></h2>
|
|
<pre><code>build/common/release.sh rc/$RELEASE rc/$NEXT_RELEASE
|
|
</code></pre>
|
|
<p>This script will merge rc/$RELEASE into release, delete the rc branch, and create a new rc
|
|
branch called rc/$NEXT_RELEASE. Verify that everything looks okay locally.</p>
|
|
<h2 id="4-push-the-release-branch"><a class="header" href="#4-push-the-release-branch">4. Push the release branch.</a></h2>
|
|
<pre><code>git push origin release
|
|
</code></pre>
|
|
<h2 id="5-create-the-github-release"><a class="header" href="#5-create-the-github-release">5. Create the GitHub release.</a></h2>
|
|
<p>Use the GitHub UI to create a GitHub release corresponding to $RELEASE version.
|
|
Make sure the target is set to the release branch.</p>
|
|
<h2 id="6-delete-the-old-rc-branch-optional"><a class="header" href="#6-delete-the-old-rc-branch-optional">6. Delete the old rc branch (optional).</a></h2>
|
|
<p>This step is optional. The old rc branch may be left alive for a few weeks for posterity.</p>
|
|
<pre><code>git push origin --delete rc/$RELEASE
|
|
</code></pre>
|
|
<h2 id="7-bump-the-version-on-the-new-rc-branch-to-next_release"><a class="header" href="#7-bump-the-version-on-the-new-rc-branch-to-next_release">7. Bump the version on the new rc branch to $NEXT_RELEASE.</a></h2>
|
|
<pre><code>git checkout rc/$NEXT_RELEASE
|
|
build/common/bump-version.sh $NEXT_RELEASE
|
|
</code></pre>
|
|
<p>Commit the changes to rc/$NEXT_RELEASE with the title:</p>
|
|
<pre><code>Bump version to $NEXT_RELEASE
|
|
</code></pre>
|
|
<h2 id="8-push-main"><a class="header" href="#8-push-main">8. Push main.</a></h2>
|
|
<pre><code>git push origin main
|
|
</code></pre>
|
|
<h2 id="9-push-the-new-rc-branch"><a class="header" href="#9-push-the-new-rc-branch">9. Push the new rc branch.</a></h2>
|
|
<pre><code>git push origin -u rc/$NEXT_RELEASE
|
|
</code></pre>
|
|
<h2 id="10-rebuild-the-github-release-if-failed"><a class="header" href="#10-rebuild-the-github-release-if-failed">10. Rebuild the GitHub release (if failed).</a></h2>
|
|
<p>Sometimes the GitHub release job will fail. In this case, you can manually re-run the release job.</p>
|
|
<h3 id="remove-any-assets-uploaded-to-the-release-if-needed"><a class="header" href="#remove-any-assets-uploaded-to-the-release-if-needed">Remove any assets uploaded to the release (if needed).</a></h3>
|
|
<p>For example, if rebuilding the Mac release, ensure that the <code>filament-<version>-mac.tgz</code> artifact
|
|
is removed from the release assets.</p>
|
|
<h3 id="update-the-release-branch-if-needed"><a class="header" href="#update-the-release-branch-if-needed">Update the release branch (if needed).</a></h3>
|
|
<p>If you need to add one or more new commits to the release, perform the following:</p>
|
|
<p>First, push the new commit(s) to the <code>release</code> branch.</p>
|
|
<p>Then, with the release branch checked out with the new commit(s), run</p>
|
|
<pre><code>git tag -f -a <release tagname>
|
|
git push origin -f <release tagname>
|
|
</code></pre>
|
|
<p>This will update and force push the tag.</p>
|
|
<h3 id="re-run-the-github-release-workflow"><a class="header" href="#re-run-the-github-release-workflow">Re-run the GitHub release workflow</a></h3>
|
|
<p>Navigate to <a href="https://github.com/google/filament/actions/workflows/release.yml">Filament's release
|
|
workflow</a>. Hit the <em>Run workflow</em>
|
|
dropdown. Modify <em>Platform to build</em> and <em>Release tag to build</em>, then hit <em>Run workflow</em>. This will
|
|
initiate a new release run.</p>
|
|
<h2 id="11-kick-off-the-npm-and-cocoapods-release-jobs"><a class="header" href="#11-kick-off-the-npm-and-cocoapods-release-jobs">11. Kick off the npm and CocoaPods release jobs</a></h2>
|
|
<p>Navigate to <a href="https://github.com/google/filament/actions/workflows/npm-deploy.yml">Filament's npm deploy
|
|
workflow</a>.
|
|
Hit the <em>Run workflow</em> dropdown. Modify <em>Release tag to deploy</em> to the tag corresponding to this
|
|
release (for example, v1.42.2).</p>
|
|
<p>Navigate to <a href="https://github.com/google/filament/actions/workflows/cocopods-deploy.yml">Filament's CocoaPods deploy
|
|
workflow</a>.
|
|
Hit the <em>Run workflow</em> dropdown. Modify <em>Release tag to deploy</em> to the tag corresponding to this
|
|
release (for example, v1.42.2).</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../notes/branching.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="../dup/docs.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="../notes/branching.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="../dup/docs.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>
|