Google Git
Sign in
chromium / external / github.com / square / leakcanary / refs/heads/gh-pages / . / releasing / index.html
blob: 786e35c2f9bfdd8e6df21daf7a689d03e0c13b4b [file] [log] [blame]
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="A memory leak detection library for Android">
<meta name="author" content="Square, Inc.">
<link rel="canonical" href="https://square.github.io/leakcanary/releasing/">
<link rel="prev" href="../dev-env/">
<link rel="next" href="../how_to_help/">
<link rel="icon" href="../images/logo.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.10">
<title>Releasing - LeakCanary</title>
<link rel="stylesheet" href="../assets/stylesheets/main.85bb2934.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.a6bdf11c.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-orange" data-md-color-accent="deep-purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#releasing-leakcanary" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
<aside class="md-banner">
<div class="md-banner__inner md-grid md-typeset">
Upgrade to <a href="../changelog/">LeakCanary <strong>2.14</strong></a> 🐤 Want to help? <a href="../how_to_help/">Here's how you can contribute<a> 🙏
</div>
</aside>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="LeakCanary" class="md-header__button md-logo" aria-label="LeakCanary" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
LeakCanary
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Releasing
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/square/leakcanary" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
LeakCanary
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="LeakCanary" class="md-nav__button md-logo" aria-label="LeakCanary" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
</a>
LeakCanary
</label>
<div class="md-nav__source">
<a href="https://github.com/square/leakcanary" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
LeakCanary
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../getting_started/" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
Fundamentals
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Fundamentals
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../fundamentals/" class="md-nav__link">
Introduction
</a>
</li>
<li class="md-nav__item">
<a href="../fundamentals-how-leakcanary-works/" class="md-nav__link">
How LeakCanary works
</a>
</li>
<li class="md-nav__item">
<a href="../fundamentals-fixing-a-memory-leak/" class="md-nav__link">
Fixing a memory leak
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
LeakCanary at scale
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
LeakCanary at scale
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../ui-tests/" class="md-nav__link">
Leak detection in UI tests
</a>
</li>
<li class="md-nav__item">
<a href="../uploading/" class="md-nav__link">
Uploading analysis results
</a>
</li>
<li class="md-nav__item">
<a href="../leakcanary-for-releases/" class="md-nav__link">
LeakCanary for releases
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
Help & Community
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Help & Community
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../recipes/" class="md-nav__link">
Code recipes
</a>
</li>
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
FAQ
</a>
</li>
<li class="md-nav__item">
<a href="../support/" class="md-nav__link">
Support
</a>
</li>
<li class="md-nav__item">
<a href="../upgrading-to-leakcanary-2.0/" class="md-nav__link">
Upgrading to LeakCanary 2
</a>
</li>
<li class="md-nav__item">
<a href="../recorded-presentations/" class="md-nav__link">
Recorded Presentations
</a>
</li>
<li class="md-nav__item">
<a href="../blog-articles/" class="md-nav__link">
Blog Articles
</a>
</li>
<li class="md-nav__item">
<a href="https://stackoverflow.com/questions/tagged/leakcanary?sort=active" class="md-nav__link">
Stack Overflow ⏏
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_8" checked>
<label class="md-nav__link" for="__nav_5_8" id="__nav_5_8_label" tabindex="0">
Contributing
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_8_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_8">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../code_of_conduct/" class="md-nav__link">
Code of Conduct
</a>
</li>
<li class="md-nav__item">
<a href="../dev-env/" class="md-nav__link">
Dev Environment
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Releasing
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Releasing
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#preparing-the-release-environment" class="md-nav__link">
Preparing the release environment
</a>
<nav class="md-nav" aria-label="Preparing the release environment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#set-up-your-sonatype-ossrh-account" class="md-nav__link">
Set up your Sonatype OSSRH account
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-your-signing-key" class="md-nav__link">
Set up your signing key
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-your-home-gradleproperties" class="md-nav__link">
Set up your home gradle.properties
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-the-google-analytics-docs-key" class="md-nav__link">
Set up the Google Analytics docs key
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-github-cli" class="md-nav__link">
Set up GitHub CLI
</a>
</li>
<li class="md-nav__item">
<a href="#install-or-update-the-doc-generation-dependencies" class="md-nav__link">
Install or update the doc generation dependencies
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#releasing" class="md-nav__link">
Releasing
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../how_to_help/" class="md-nav__link">
How to help
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
Shark
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Shark
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../shark/" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../api/shark/" class="md-nav__link">
Shark API
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../api/leakcanary/" class="md-nav__link">
LeakCanary API
</a>
</li>
<li class="md-nav__item">
<a href="../changelog/" class="md-nav__link">
Change Log
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#preparing-the-release-environment" class="md-nav__link">
Preparing the release environment
</a>
<nav class="md-nav" aria-label="Preparing the release environment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#set-up-your-sonatype-ossrh-account" class="md-nav__link">
Set up your Sonatype OSSRH account
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-your-signing-key" class="md-nav__link">
Set up your signing key
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-your-home-gradleproperties" class="md-nav__link">
Set up your home gradle.properties
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-the-google-analytics-docs-key" class="md-nav__link">
Set up the Google Analytics docs key
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-github-cli" class="md-nav__link">
Set up GitHub CLI
</a>
</li>
<li class="md-nav__item">
<a href="#install-or-update-the-doc-generation-dependencies" class="md-nav__link">
Install or update the doc generation dependencies
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#releasing" class="md-nav__link">
Releasing
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<span style="float: right">🤔 Documentation issue? <a href="https://github.com/square/leakcanary/issues/new?assignees=&labels=type%3A+documentation&template=4-doc.md&title=Doc%20issue%20with%20releasing/%20page">Report</a> or <a href="https://github.com/square/leakcanary/edit/main/docs/releasing.md">edit</a></span>
<h1 id="releasing-leakcanary">Releasing LeakCanary<a class="headerlink" href="#releasing-leakcanary" title="Permanent link">&para;</a></h1>
<h2 id="preparing-the-release-environment">Preparing the release environment<a class="headerlink" href="#preparing-the-release-environment" title="Permanent link">&para;</a></h2>
<h3 id="set-up-your-sonatype-ossrh-account">Set up your Sonatype OSSRH account<a class="headerlink" href="#set-up-your-sonatype-ossrh-account" title="Permanent link">&para;</a></h3>
<ul>
<li>Create a <a href="https://issues.sonatype.org/secure/Signup!default.jspa">Sonatype OSSRH JIRA account</a>.</li>
<li>Create a ticket to request access to the <code>com.squareup.leakcanary</code> project. Here&rsquo;s an example: <a href="https://issues.sonatype.org/browse/OSSRH-54959">OSSRH-54959</a>.</li>
<li>Then ask someone with deployer role from the LeakCanary team to confirm access.</li>
</ul>
<h3 id="set-up-your-signing-key">Set up your signing key<a class="headerlink" href="#set-up-your-signing-key" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a new key</span>
gpg<span class="w"> </span>--gen-key
<span class="c1"># List local keys. Key id is last 8 characters</span>
gpg<span class="w"> </span>-K
<span class="nb">cd</span><span class="w"> </span>~/.gnupg
<span class="c1"># Export key locally</span>
gpg<span class="w"> </span>--export-secret-keys<span class="w"> </span>-o<span class="w"> </span>secring.gpg
<span class="c1"># Upload key to Ubuntu servers</span>
gpg<span class="w"> </span>--send-keys<span class="w"> </span>--keyserver<span class="w"> </span>keyserver.ubuntu.com<span class="w"> </span>&lt;KEY<span class="w"> </span>ID&gt;
<span class="c1"># Confirm the key can now be found</span>
gpg<span class="w"> </span>--recv-keys<span class="w"> </span>--keyserver<span class="w"> </span>keyserver.ubuntu.com<span class="w"> </span>&lt;KEY<span class="w"> </span>ID&gt;
</code></pre></div>
<h3 id="set-up-your-home-gradleproperties">Set up your home gradle.properties<a class="headerlink" href="#set-up-your-home-gradleproperties" title="Permanent link">&para;</a></h3>
<p>Add this to your <code>~/.gradle/gradle.properties</code>:</p>
<div class="highlight"><pre><span></span><code>signing.keyId=&lt;KEY ID&gt;
signing.password=&lt;KEY PASSWORD&gt;
signing.secretKeyRingFile=/Users/YOUR_USERNAME_/.gnupg/secring.gpg
SONATYPE_NEXUS_USERNAME=&lt;SONATYPE_USERNAME&gt;
SONATYPE_NEXUS_PASSWORD=&lt;SONATYPE_PASSWORD&gt;
</code></pre></div>
<h3 id="set-up-the-google-analytics-docs-key">Set up the Google Analytics docs key<a class="headerlink" href="#set-up-the-google-analytics-docs-key" title="Permanent link">&para;</a></h3>
<p>Add this to your <code>~/.bashrc</code>:</p>
<div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">LEAKCANARY_GOOGLE_ANALYTICS_KEY</span><span class="o">=</span><span class="s2">&quot;UA-142834539-1&quot;</span>
</code></pre></div>
<h3 id="set-up-github-cli">Set up GitHub CLI<a class="headerlink" href="#set-up-github-cli" title="Permanent link">&para;</a></h3>
<p>Install GitHub CLI</p>
<div class="highlight"><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>gh
</code></pre></div>
<p>Install jq, a CLI Json processor</p>
<div class="highlight"><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>jq
</code></pre></div>
<p>Set up aliases for milestone management:</p>
<div class="highlight"><pre><span></span><code>gh<span class="w"> </span><span class="nb">alias</span><span class="w"> </span><span class="nb">set</span><span class="w"> </span>listOpenMilestones<span class="w"> </span><span class="s2">&quot;api graphql -F owner=&#39;:owner&#39; -F name=&#39;:repo&#39; -f query=&#39;</span>
<span class="s2"> query ListOpenMilestones(\$name: String\!, \$owner: String\!) {</span>
<span class="s2"> repository(owner: \$owner, name: \$name) {</span>
<span class="s2"> milestones(first: 100, states: OPEN) {</span>
<span class="s2"> nodes {</span>
<span class="s2"> title</span>
<span class="s2"> number</span>
<span class="s2"> description</span>
<span class="s2"> dueOn</span>
<span class="s2"> url</span>
<span class="s2"> state</span>
<span class="s2"> closed</span>
<span class="s2"> closedAt</span>
<span class="s2"> updatedAt</span>
<span class="s2"> }</span>
<span class="s2"> }</span>
<span class="s2"> }</span>
<span class="s2"> }</span>
<span class="s2">&#39;&quot;</span>
gh<span class="w"> </span><span class="nb">alias</span><span class="w"> </span><span class="nb">set</span><span class="w"> </span>--shell<span class="w"> </span>createMilestone<span class="w"> </span><span class="s2">&quot;gh api --method POST repos/:owner/:repo/milestones --input - | jq &#39;{ html_url: .html_url, state: .state, created_at: .created_at }&#39;&quot;</span>
gh<span class="w"> </span><span class="nb">alias</span><span class="w"> </span><span class="nb">set</span><span class="w"> </span>--shell<span class="w"> </span>closeMilestone<span class="w"> </span><span class="s2">&quot;echo &#39;{\&quot;state\&quot;: \&quot;closed\&quot;}&#39; | gh api --method PATCH repos/:owner/:repo/milestones/\$1 --input - | jq &#39;{ html_url: .html_url, state: .state, closed_at: .closed_at }&#39;&quot;</span>
</code></pre></div>
<h3 id="install-or-update-the-doc-generation-dependencies">Install or update the doc generation dependencies<a class="headerlink" href="#install-or-update-the-doc-generation-dependencies" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>pip3<span class="w"> </span>install<span class="w"> </span>--requirement<span class="w"> </span>docs/requirements.txt
</code></pre></div>
<h2 id="releasing">Releasing<a class="headerlink" href="#releasing" title="Permanent link">&para;</a></h2>
<ul>
<li>
<p>Create a local release branch from <code>main</code>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>checkout<span class="w"> </span>main<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>pull<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>release_3.0-alpha-3
</code></pre></div></p>
</li>
<li>
<p>Update <code>VERSION_NAME</code> in <code>gradle.properties</code> (remove <code>-SNAPSHOT</code>)
<div class="highlight"><pre><span></span><code>sed -i &#39;&#39; &#39;s/VERSION_NAME=3.0-alpha-3-SNAPSHOT/VERSION_NAME=3.0-alpha-3/&#39; gradle.properties
</code></pre></div></p>
</li>
<li>
<p>Update the current version and next version in <code>mkdocs.yml</code>
<div class="highlight"><pre><span></span><code>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">&#39;&#39;</span><span class="w"> </span><span class="s1">&#39;s/3.0-alpha-3/NEXT/&#39;</span><span class="w"> </span>mkdocs.yml
sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">&#39;&#39;</span><span class="w"> </span><span class="s1">&#39;s/2.14/3.0-alpha-3/&#39;</span><span class="w"> </span>mkdocs.yml
</code></pre></div></p>
</li>
<li>
<p>Create the release
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>commit<span class="w"> </span>-am<span class="w"> </span><span class="s2">&quot;Prepare 3.0-alpha-3 release&quot;</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
./gradlew<span class="w"> </span>clean<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
./gradlew<span class="w"> </span>build<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>tag<span class="w"> </span>v3.0-alpha-3<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>v3.0-alpha-3<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
./gradlew<span class="w"> </span>publish<span class="w"> </span>--no-daemon<span class="w"> </span>--no-parallel<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
./gradlew<span class="w"> </span>closeAndReleaseRepository<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
./gradlew<span class="w"> </span>shark:shark-cli:distZip
</code></pre></div></p>
</li>
</ul>
<p>Note: if anything goes wrong, you can manually drop the release at <a href="https://s01.oss.sonatype.org/">https://s01.oss.sonatype.org/</a></p>
<ul>
<li>Merge back to main
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>checkout<span class="w"> </span>main<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>pull<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>merge<span class="w"> </span>--no-ff<span class="w"> </span>release_3.0-alpha-3
</code></pre></div></li>
<li>
<p>Update <code>VERSION_NAME</code> in <code>gradle.properties</code> (increase version and add <code>-SNAPSHOT</code>)
<div class="highlight"><pre><span></span><code>sed -i &#39;&#39; &#39;s/VERSION_NAME=3.0-alpha-3/VERSION_NAME=NEXT-SNAPSHOT/&#39; gradle.properties
</code></pre></div></p>
</li>
<li>
<p>Generate the Dokka docs
<div class="highlight"><pre><span></span><code>rm<span class="w"> </span>-rf<span class="w"> </span>docs/api<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>./gradlew<span class="w"> </span>siteDokka
</code></pre></div></p>
</li>
<li>
<p>Update the changelog (<a href="https://github.com/square/leakcanary/compare/v2.14...main">commit list</a>)
<div class="highlight"><pre><span></span><code>mate docs/changelog.md
</code></pre></div></p>
</li>
<li>
<p>Deploy the docs locally then <a href="http://127.0.0.1:8000/leakcanary/changelog/">open the changelog</a> and check everything looks good
<div class="highlight"><pre><span></span><code>mkdocs<span class="w"> </span>serve
</code></pre></div></p>
</li>
<li>
<p>Finish up the release</p>
</li>
</ul>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>commit<span class="w"> </span>-am<span class="w"> </span><span class="s2">&quot;Prepare for next development iteration&quot;</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
git<span class="w"> </span>push<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
gh<span class="w"> </span>listOpenMilestones<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span><span class="s1">&#39;.data.repository.milestones.nodes[0].number&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>xargs<span class="w"> </span>gh<span class="w"> </span>closeMilestone<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
<span class="nb">echo</span><span class="w"> </span><span class="s1">&#39;{</span>
<span class="s1"> &quot;title&quot;: &quot;REPLACE_WITH_NEXT_VERSION_NUMBER&quot;,</span>
<span class="s1"> &quot;state&quot;: &quot;open&quot;,</span>
<span class="s1"> &quot;description&quot;: &quot;&quot;</span>
<span class="s1">}&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>gh<span class="w"> </span>createMilestone<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="se">\</span>
mkdocs<span class="w"> </span>gh-deploy
gh<span class="w"> </span>release<span class="w"> </span>create<span class="w"> </span>v3.0-alpha-3<span class="w"> </span>./shark-cli/build/distributions/shark-cli-3.0-alpha-3.zip<span class="w"> </span>--title<span class="w"> </span>v3.0-alpha-3<span class="w"> </span>--notes<span class="w"> </span><span class="s1">&#39;See [Change Log](https://square.github.io/leakcanary/changelog)&#39;</span>
</code></pre></div>
<ul>
<li>
<p>Open the <a href="https://github.com/square/leakcanary/releases/tag/v3.0-alpha-3">v3.0-alpha-3 release</a> to confirm everything looks good.</p>
</li>
<li>
<p>Upload shark-cli to <a href="https://brew.sh/">brew</a>:
<div class="highlight"><pre><span></span><code>brew<span class="w"> </span>bump-formula-pr<span class="w"> </span>--url<span class="w"> </span>https://github.com/square/leakcanary/releases/download/v3.0-alpha-3/shark-cli-3.0-alpha-3.zip<span class="w"> </span>leakcanary-shark
</code></pre></div></p>
</li>
<li>
<p>Wait for the release to be available <a href="https://repo1.maven.org/maven2/com/squareup/leakcanary/leakcanary-android/">on Maven Central</a>.</p>
</li>
<li>Tell your friends, update all of your apps, and tweet the new release. As a nice extra touch, mention external contributions.</li>
</ul>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2015 Square, Inc.
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://square.github.io/" target="_blank" rel="noopener" title="square.github.io" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg>
</a>
<a href="https://twitter.com/Piwai" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
</a>
<a href="https://stackoverflow.com/questions/tagged/leakcanary?sort=active" target="_blank" rel="noopener" title="stackoverflow.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M290.7 311 95 269.7 86.8 309l195.7 41zm51-87L188.2 95.7l-25.5 30.8 153.5 128.3zm-31.2 39.7L129.2 179l-16.7 36.5L293.7 300zM262 32l-32 24 119.3 160.3 32-24zm20.5 328h-200v39.7h200zm39.7 80H42.7V320h-40v160h359.5V320h-40z"/></svg>
</a>
<a href="https://www.linkedin.com/company/joinsquare/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["tabs"], "search": "../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.fac441b0.min.js"></script>
</body>
</html>